oracle.adfinternal.businesseditor.restapi

Class BusinessObjectImpl

java.lang.Object

oracle.adfinternal.businesseditor.restapi.BusinessObjectImpl

All Implemented Interfaces:

BusinessObject, VOAttributesConstants

public class BusinessObjectImpl
extends java.lang.Object
implements BusinessObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseObject.ChildAlreadyExists
protected static interface	BaseObject.Manager
protected static class	BaseObject.Matcher
protected static class	BaseObject.STATE
protected static class	BaseObject.UnsupportedRestOperationException

Field Summary

Fields inherited from interface oracle.adfinternal.businesseditor.restapi.VOAttributesConstants

ADDL_LIST_DISPLAY_FIELDS, ADDL_LIST_SEARCH_FIELDS, API_NAME, BODY, CHILD_LOOKUP_CODES, DATA_FILTERS, DATETIME_DISPLAY_TYPE, DECIMAL_PLACES, DEFAULT_VALUE, DEFINITION, DEPENDENCY_FIELDS, DESCRIPTION, DISPLAY_HEIGHT, DISPLAY_LABEL, DISPLAY_LABEL_PLURAL, DISPLAY_SEQUENCE, DISPLAY_WIDTH, ENABLED, END_DATE_ACTIVE, ERROR_MESSAGE, EXAMPLE, EXPRESSION, FIELDS, FORMULA_TYPE, FULL_NAME, FUNCTION_ID, FUNCTIONS, GLOBAL_FUNCTIONS, HELP_TEXT, ID, INDEXED, IS_CUSTOM, IS_MULTISELECT_PICKLIST, LIST_DISPLAY_FIELD, LIST_OBJECT, LOOKUP_CODE, LOOKUP_TYPE, LOOKUP_TYPES, LOOKUPS, MATCH_CASE, MAX_LENGTH, MAX_VALUE, MEANING, MIN_LENGTH, MIN_VALUE, NAME, OBJECTS, OPERATOR, PARAMETERS, PARENT_BUSINESS_OBJECT, PARENT_LOOKUP_CODE, PARENT_PICKLIST, PICKLIST_LOOKUP_TYPE, PRIVILEGE, PUBLISHED_AS_REST, RECORD_NAME_LABEL, REQUIRED, REQUIRED_EXPRESSION, RETURN_TYPE, SEARCH_FIELD_API_NAME, SORT_BY, SORT_BY_ASCENDING, START_DATE_ACTIVE, TRIGGERS, TYPE, UPDATABLE, UPDATABLE_EXPRESSION, VALIDATORS, VALUE_MAP, VALUE1, VALUE2, VISIBILITY_PROPERTY

Constructor Summary

Constructors

Constructor and Description
BusinessObjectImpl(BusinessEditorManagerImpl manager, org.codehaus.jettison.json.JSONObject obj)

Method Summary

Modifier and Type	Method and Description
void	accept(ObjectVisitor visitor) Visitor pattern is implemented for the business object to allow visiting each component of a business object using a custom visitor.
void	activate() Activate a business object
protected org.codehaus.jettison.json.JSONObject	convertToJSON(java.lang.Object... attrNameAndValues)
CustomAttribute	createAttribute(java.lang.String name, AttributeType attrType) Create a custom attribute for the given name and type.
CustomAttribute	createAttribute(java.lang.String name, java.lang.String type) Create a custom attribute for the given name and type.
protected <T> T	createChild(java.lang.String accessorName, java.lang.Class<T> type, org.codehaus.jettison.json.JSONObject obj)
BusinessObjectFunction	createFunction(java.lang.String name, java.lang.String returnType, java.lang.String body) Create a function for this business object.
BusinessObjectTrigger	createTrigger(BusinessObjectTriggerType triggerType, java.lang.String name, java.lang.String triggerDefinition, java.lang.String errorMessage) Create a trigger for this business object.
BusinessObjectValidator	createValidator(java.lang.String name, java.lang.String ruleDefinition, java.lang.String errorMessage) Create a validator for this business object.
void	deleteAttribute(CustomAttribute attr) Delete a custom attribute.
protected void	deleteChild(BaseObject.Matcher matcher)
protected void	deleteChild(java.lang.String accessorName, java.lang.String childName)
void	deleteFunction(BusinessObjectFunction function) Delete a function from this business object.
void	deleteTrigger(BusinessObjectTrigger trigger) Delete a trigger from this business object.
void	deleteValidator(BusinessObjectValidator validator) Delete a validator from this business object.
void	deprecate() Deprecate a business object
void	depublishRESTWebService() Depublish REST web service for the custom object
void	doCreateNewChildren()
void	doDeleteChildren()
void	doSetAttributes()
boolean	equals(java.lang.Object obj)
Attribute	findAttribute(java.lang.String name) Retrive the attribute of the given name.
protected <T> T	findChild(java.lang.Class<T> type, BaseObject.Matcher matcher)
protected <T> T	findChild(java.lang.String accessorName, java.lang.String childName, java.lang.Class<T> type)
protected <T> java.util.List<T>	findChildren(java.lang.Class<T> type, BaseObject.Matcher matcher) Find all children objects matching the given Matcher.
BusinessObjectFunction	findFunction(java.lang.String name, java.lang.String[] paramTypes) Retrieves the function with the given name for the business object.
java.util.Collection<BusinessObjectFunction>	findFunctions(java.lang.String name) Retrieves all functions with the name for the business object.
BusinessObjectTrigger	findTrigger(java.lang.String name) Retrieve the trigger of the given name.
BusinessObjectValidator	findValidator(java.lang.String name) Retrive the validator of the given name.
protected java.lang.String	getAccessorNameFromOwner() Get the resource name that is used by the owner to access this type of object.
java.lang.String	getAPIName() Returns the API name of the object.
protected java.lang.Object	getAttribute(java.lang.String attrName)
protected java.lang.Object	getAttribute(java.lang.String attrName, java.lang.Object defaultValue) Get the attribute value for the given attribute name.
java.util.Collection<Attribute>	getAttributes() For customizable business object, this method will return all standard and custom attributes for this business object.
java.lang.String	getAutoNumberPattern() Returns the auto number pattern of the object.
java.lang.String	getChildCollectionName() Return the internal name of the child object records set.
protected <T> java.util.Collection<T>	getChildren(java.lang.String accessorName, java.lang.Class<T> type)
protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject>	getChildrenDeleted(BaseObject.Matcher childMatcher)
protected org.codehaus.jettison.json.JSONArray	getChildrenJSON(java.lang.String accessorName) Get all children of a given type defined by accessorName.
protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject>	getChildrenNew(BaseObject.Matcher childMatcher)
java.util.Collection<CustomAttribute>	getCustomAttributes() Retrieve all custom attributes for this business object.
java.util.Map<java.lang.String,java.lang.String>	getCustomProperties(java.lang.String namespace) Return a map of custom properties for the attribute with the given namespace
java.lang.String	getCustomProperty(java.lang.String namespace, java.lang.String name) Return the value of the custom property with the given namespace and name
java.lang.String	getDescription()
java.lang.String	getDisplayLabel() Returns the display label of the object.
java.lang.String	getDisplayNamePlural() Returns the plural display label of the object.
protected java.lang.String	getFinderKey(java.lang.String accessorName) Get the key whose value defines the resource name for this object in URL path
java.lang.String	getFullName() Returns the full name of the object.
java.util.Collection<BusinessObjectFunction>	getFunctions() Retrieve all functions for the business object.
protected java.lang.String	getInternalName() Name that will represent the resource id for this object.
static java.lang.String	getLocalizedString(java.lang.String key, java.lang.Object... args)
protected oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger	getLogger()
BaseObject.Matcher	getMatcher() Get a Matcher that is used to compare with another object.
java.lang.String	getName()
protected oracle.adfinternal.businesseditor.restapi.BaseObject	getOwner() Get the container object that contains this object.
BusinessObject	getParent() Return the parent object if the business object is a child object.
java.lang.Object	getProperty(java.lang.String hintName)
java.lang.Object	getProperty(java.lang.String hintName, oracle.jbo.LocaleContext locale)
protected java.lang.String[]	getQueryKeys(java.lang.String accessorName) Different types of objects use different names to find a child object.
java.lang.String	getRecordNameLabel() Returns the record name label of the object.
Attribute	getSortByAttribute() Returns the sort by attribute of the object.
java.util.Collection<StandardAttribute>	getStandardAttributes() Retrieve all standard attributes for this business object.
protected BaseObject.STATE	getState()
java.util.Collection<BusinessObjectTrigger>	getTriggers() Retrieve all triggers for this business object.
java.util.Collection<BusinessObjectValidator>	getValidators() Retrieve all validators for this business object.
protected <T> T	initChildObject(java.lang.String accessorName, org.codehaus.jettison.json.JSONObject child, java.lang.Class<T> type) Various methods that return child object needs to create the child object.
boolean	isCaseSensitiveRecordNameUniqueness() Returns true if a custom business object enforces unique record names in a case-sensitive way
boolean	isCustomizable() Return if a business object can be customized.
boolean	isCustomObject() Return if a business object is a custom object
boolean	isDeprecated() Return if a business object is deprecated
boolean	isEnforceUniqueRecordName() Returns true if a custom business object enforces unique record names
boolean	isNew()
protected boolean	isPropertyUpdateable(java.lang.String property)
boolean	isRemovable() Return if business object is removable.
boolean	isRESTEnabledForDELETE() Return if DELETE operation is enabled for REST web service
boolean	isRESTEnabledForGET() Return if GET operation is enabled for REST web service
boolean	isRESTEnabledForPOST() Return if POST operation is enabled for REST web service
boolean	isRESTEnabledForPUT() Return if PUT operation is enabled for REST web service
boolean	isRESTWebServicePublished() Return if REST web service is published for the business object
boolean	isSortByAscending() Returns the sort by direction of the object.
void	publishRESTWebService() Publish REST web service for the custom object
protected void	setAttribute(java.lang.String attrName, java.lang.Object value)
void	setAutoNumberPattern(java.lang.String value) Set the auto number pattern of the object.
void	setCaseSensitiveRecordNameUniqueness(boolean caseSensitive) Determines whether a custom business object enforces unique record names in a case-sensitive way.
void	setChildCollectionName(java.lang.String childCollectionName) Set the name of the child object records set
void	setCustomProperty(java.lang.String namespace, java.lang.String name, java.lang.String value) Create or update a custom property of the given namespace and name with the value
void	setDescription(java.lang.String text)
void	setDisplayLabel(java.lang.String text) Set the display label of the object.
void	setDisplayNamePlural(java.lang.String value) Set the plural display label of the object.
void	setEnforceUniqueRecordName(boolean uniqueRecName) Determines whether a custom business object enforces unique record names
protected void	setLogger(oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger logger)
void	setName(java.lang.String name) Renames this object.
void	setProperty(java.lang.String hintName, java.lang.Object hintValue, oracle.jbo.LocaleContext locale)
void	setRecordNameLabel(java.lang.String value) Set the record name label of the object.
void	setRESTEnabledForDELETE(boolean enabled) Set if DELETE operation is enabled for REST web service
void	setRESTEnabledForGET(boolean enabled) Set if GET operation is enabled for REST web service
void	setRESTEnabledForPOST(boolean enabled) Set if POST operation is enabled for REST web service
void	setRESTEnabledForPUT(boolean enabled) Set if PUT operation is enabled for REST web service
void	setSortBy(Attribute attribute, boolean ascending) Set the sort by attribute name and direction of the object.
protected java.lang.String	toApiName(java.lang.String name)
void	undoChanges()
protected void	verifyObjectIsValid() Verifies if object is valid.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.adf.businesseditor.objects.BusinessObject

getDescription, getName, setDescription

Constructor Detail

BusinessObjectImpl

public BusinessObjectImpl(BusinessEditorManagerImpl manager,
                          org.codehaus.jettison.json.JSONObject obj)
                   throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getAccessorNameFromOwner

protected java.lang.String getAccessorNameFromOwner()

Get the resource name that is used by the owner to access this type of object. For example, it will return "BusinessObjects for a business object, "Fields" for an Attribute object.

Returns:

resource name the owner uses to access this type of object.

initChildObject

protected <T> T initChildObject(java.lang.String accessorName,
                                org.codehaus.jettison.json.JSONObject child,
                                java.lang.Class<T> type)

Various methods that return child object needs to create the child object. It is best known to the owning object. Hence to be implemented by the owning object.

Type Parameters:

T - Class that is expected type of the returned child object.

Parameters:

accessorName - resource name used to access the child

child - JSON structure of the child object

type - Class instance of the expected type of child object

Returns:

an instance of BaseObject that represents the child

toApiName

protected java.lang.String toApiName(java.lang.String name)

getAttributes

public java.util.Collection<Attribute> getAttributes()

Description copied from interface: BusinessObject

For customizable business object, this method will return all standard and custom attributes for this business object. For non-customizable business object, only the attributes that can be used as list display or search attribute for dynamic choice list are returned. Use BusinessObject.isCustomizable() to identify if a business object is customizable.

Specified by:

getAttributes in interface BusinessObject

Returns:

collection of attributes

getStandardAttributes

public java.util.Collection<StandardAttribute> getStandardAttributes()

Description copied from interface: BusinessObject

Retrieve all standard attributes for this business object.

Specified by:

getStandardAttributes in interface BusinessObject

Returns:

collection of standard attributes

getCustomAttributes

public java.util.Collection<CustomAttribute> getCustomAttributes()

Description copied from interface: BusinessObject

Retrieve all custom attributes for this business object.

Specified by:

getCustomAttributes in interface BusinessObject

Returns:

collection of custom attributes

findAttribute

public Attribute findAttribute(java.lang.String name)

Description copied from interface: BusinessObject

Retrive the attribute of the given name. If no attribute exists for the name, null is returned. Either API name or name can be used in finding an attribute. However, when a name is used by both standard attribute and custom attribute, the standard attribute will be returned. To get the custom attribute in this case, api name must be used.

Specified by:

findAttribute in interface BusinessObject

Parameters:

name - name of the attribute.

Returns:

attribute with the given name

createAttribute

public CustomAttribute createAttribute(java.lang.String name,
                                       AttributeType attrType)

Description copied from interface: BusinessObject

Create a custom attribute for the given name and type.

Specified by:

createAttribute in interface BusinessObject

Parameters:

name - name of the attribute

attrType - type of the attribute in AttributeType

Returns:

the custom attribute created for the name and type.

createAttribute

public CustomAttribute createAttribute(java.lang.String name,
                                       java.lang.String type)

Description copied from interface: BusinessObject

Create a custom attribute for the given name and type.

Specified by:

createAttribute in interface BusinessObject

Parameters:

name - name of the attribute

type - type of the attribute in String. It is

Returns:

the custom attribute created for the name and type.

deleteAttribute

public void deleteAttribute(CustomAttribute attr)

Description copied from interface: BusinessObject

Delete a custom attribute.

Specified by:

deleteAttribute in interface BusinessObject

Parameters:

attr - custom attribute to be deleted

getValidators

public java.util.Collection<BusinessObjectValidator> getValidators()

Description copied from interface: BusinessObject

Retrieve all validators for this business object.

Specified by:

getValidators in interface BusinessObject

Returns:

collection of validators

findValidator

public BusinessObjectValidator findValidator(java.lang.String name)

Description copied from interface: BusinessObject

Retrive the validator of the given name. If no validator exists for the name, null is returned.

Specified by:

findValidator in interface BusinessObject

Parameters:

name - name of the validator.

Returns:

validator with the given name

createValidator

public BusinessObjectValidator createValidator(java.lang.String name,
                                               java.lang.String ruleDefinition,
                                               java.lang.String errorMessage)

Description copied from interface: BusinessObject

Create a validator for this business object.

Specified by:

createValidator in interface BusinessObject

Parameters:

name - name of the validator

ruleDefinition - rule definition of the validator

errorMessage - error message of the validator

Returns:

the validator created for the name.

deleteValidator

public void deleteValidator(BusinessObjectValidator validator)

Description copied from interface: BusinessObject

Delete a validator from this business object.

Specified by:

deleteValidator in interface BusinessObject

Parameters:

validator - name of the validator

getTriggers

public java.util.Collection<BusinessObjectTrigger> getTriggers()

Description copied from interface: BusinessObject

Retrieve all triggers for this business object.

Specified by:

getTriggers in interface BusinessObject

Returns:

collection of triggers

findTrigger

public BusinessObjectTrigger findTrigger(java.lang.String name)

Description copied from interface: BusinessObject

Retrieve the trigger of the given name. If no trigger exists for the name, null is returned.

Specified by:

findTrigger in interface BusinessObject

Parameters:

name - name of the trigger.

Returns:

trigger with the given name

createTrigger

public BusinessObjectTrigger createTrigger(BusinessObjectTriggerType triggerType,
                                           java.lang.String name,
                                           java.lang.String triggerDefinition,
                                           java.lang.String errorMessage)

Description copied from interface: BusinessObject

Create a trigger for this business object.

Specified by:

createTrigger in interface BusinessObject

Parameters:

triggerType - type of the trigger.

name - name of the trigger.

triggerDefinition - trigger definition of the trigger

errorMessage - error message of the trigger

Returns:

the trigger created for the type and name.

deleteTrigger

public void deleteTrigger(BusinessObjectTrigger trigger)

Description copied from interface: BusinessObject

Delete a trigger from this business object.

Specified by:

deleteTrigger in interface BusinessObject

Parameters:

trigger - name of the trigger

getFunctions

public java.util.Collection<BusinessObjectFunction> getFunctions()

Description copied from interface: BusinessObject

Retrieve all functions for the business object.

Specified by:

getFunctions in interface BusinessObject

Returns:

collection of functions

findFunction

public BusinessObjectFunction findFunction(java.lang.String name,
                                           java.lang.String[] paramTypes)

Description copied from interface: BusinessObject

Retrieves the function with the given name for the business object. If there are multiple functions with the given name for a business object, paramTypes must be used to specify the right function to be returned. If no paramTypes is specified, a function is returned if there is only one function with the given name, or if there is one function with the name for the business object that does not contain any parameter. If no function is found for the given name, null is returned.

Specified by:

findFunction in interface BusinessObject

Parameters:

name - name of the business object function to be returned

paramTypes - parameter types for function

Returns:

business object function

findFunctions

public java.util.Collection<BusinessObjectFunction> findFunctions(java.lang.String name)

Description copied from interface: BusinessObject

Retrieves all functions with the name for the business object.

Specified by:

findFunctions in interface BusinessObject

Parameters:

name - name of the functions to be returned

Returns:

business object functions

createFunction

public BusinessObjectFunction createFunction(java.lang.String name,
                                             java.lang.String returnType,
                                             java.lang.String body)

Description copied from interface: BusinessObject

Create a function for this business object.

Specified by:

createFunction in interface BusinessObject

Parameters:

name - name of the function.

returnType - return type of the function

body - function body of the function

Returns:

the function created for the name.

deleteFunction

public void deleteFunction(BusinessObjectFunction function)

Description copied from interface: BusinessObject

Delete a function from this business object.

Specified by:

deleteFunction in interface BusinessObject

Parameters:

function - function to be deleted

setDisplayLabel

public void setDisplayLabel(java.lang.String text)

Description copied from interface: BusinessObject

Set the display label of the object.

Specified by:

setDisplayLabel in interface BusinessObject

Parameters:

text - display label of the object

getDisplayLabel

public java.lang.String getDisplayLabel()

Description copied from interface: BusinessObject

Returns the display label of the object.

Specified by:

getDisplayLabel in interface BusinessObject

Returns:

the display label of the object

setDisplayNamePlural

public void setDisplayNamePlural(java.lang.String value)

Description copied from interface: BusinessObject

Set the plural display label of the object.

Specified by:

setDisplayNamePlural in interface BusinessObject

Parameters:

value - plural display label of the object

getDisplayNamePlural

public java.lang.String getDisplayNamePlural()

Description copied from interface: BusinessObject

Returns the plural display label of the object.

Specified by:

getDisplayNamePlural in interface BusinessObject

Returns:

the plural display label of the object

setRecordNameLabel

public void setRecordNameLabel(java.lang.String value)

Description copied from interface: BusinessObject

Set the record name label of the object. Throws JboException if it is not a custom business object.

Specified by:

setRecordNameLabel in interface BusinessObject

Parameters:

value - record name label of the object

getRecordNameLabel

public java.lang.String getRecordNameLabel()

Description copied from interface: BusinessObject

Returns the record name label of the object.

Specified by:

getRecordNameLabel in interface BusinessObject

Returns:

the record name label of the object

setSortBy

public void setSortBy(Attribute attribute,
                      boolean ascending)

Description copied from interface: BusinessObject

Set the sort by attribute name and direction of the object. Throws JboException if it is not a custom business object.

Specified by:

setSortBy in interface BusinessObject

Parameters:

attribute - sort by attribute on the object

ascending - sort direction, ascending or descending.

getSortByAttribute

public Attribute getSortByAttribute()

Description copied from interface: BusinessObject

Returns the sort by attribute of the object.

Specified by:

getSortByAttribute in interface BusinessObject

Returns:

the sort by attribute of the object

isSortByAscending

public boolean isSortByAscending()

Description copied from interface: BusinessObject

Returns the sort by direction of the object.

Specified by:

isSortByAscending in interface BusinessObject

Returns:

the sort by direction of the object

setAutoNumberPattern

public void setAutoNumberPattern(java.lang.String value)

Description copied from interface: BusinessObject

Set the auto number pattern of the object. Throws JboException if it is not a custom business object.

Specified by:

setAutoNumberPattern in interface BusinessObject

Parameters:

value - auto number pattern of the object

getAutoNumberPattern

public java.lang.String getAutoNumberPattern()

Description copied from interface: BusinessObject

Returns the auto number pattern of the object.

Specified by:

getAutoNumberPattern in interface BusinessObject

Returns:

the auto number pattern of the object

getFullName

public java.lang.String getFullName()

Description copied from interface: BusinessObject

Returns the full name of the object.

Specified by:

getFullName in interface BusinessObject

Returns:

the full name of the object

getAPIName

public java.lang.String getAPIName()

Description copied from interface: BusinessObject

Returns the API name of the object.

Specified by:

getAPIName in interface BusinessObject

Returns:

the API name of the object

getParent

public BusinessObject getParent()

Description copied from interface: BusinessObject

Return the parent object if the business object is a child object. Otherwise null will be returned.

Specified by:

getParent in interface BusinessObject

Returns:

the parent object if exists

setChildCollectionName

public void setChildCollectionName(java.lang.String childCollectionName)

Description copied from interface: BusinessObject

Set the name of the child object records set

Specified by:

setChildCollectionName in interface BusinessObject

Parameters:

childCollectionName - the name of the child object records set

getChildCollectionName

public java.lang.String getChildCollectionName()

Description copied from interface: BusinessObject

Return the internal name of the child object records set. That is, if customObjectPrefix or customObjectSuffix is defined in the ADFm settings, this name will include the prefix and/or suffix.

Specified by:

getChildCollectionName in interface BusinessObject

Returns:

the internal name of the child object records set

isRemovable

public boolean isRemovable()

Description copied from interface: BusinessObject

Return if business object is removable.

Specified by:

isRemovable in interface BusinessObject

Returns:

if business object is removable

publishRESTWebService

public void publishRESTWebService()

Description copied from interface: BusinessObject

Publish REST web service for the custom object

Specified by:

publishRESTWebService in interface BusinessObject

depublishRESTWebService

public void depublishRESTWebService()

Description copied from interface: BusinessObject

Depublish REST web service for the custom object

Specified by:

depublishRESTWebService in interface BusinessObject

isRESTWebServicePublished

public boolean isRESTWebServicePublished()

Description copied from interface: BusinessObject

Return if REST web service is published for the business object

Specified by:

isRESTWebServicePublished in interface BusinessObject

Returns:

if REST web service is published

setRESTEnabledForGET

public void setRESTEnabledForGET(boolean enabled)

Description copied from interface: BusinessObject

Set if GET operation is enabled for REST web service

Specified by:

setRESTEnabledForGET in interface BusinessObject

Parameters:

enabled - if GET operation should be enabled

isRESTEnabledForGET

public boolean isRESTEnabledForGET()

Description copied from interface: BusinessObject

Return if GET operation is enabled for REST web service

Specified by:

isRESTEnabledForGET in interface BusinessObject

Returns:

if GET operation is enabled

setRESTEnabledForPOST

public void setRESTEnabledForPOST(boolean enabled)

Description copied from interface: BusinessObject

Set if POST operation is enabled for REST web service

Specified by:

setRESTEnabledForPOST in interface BusinessObject

Parameters:

enabled - if POST operation should be enabled

isRESTEnabledForPOST

public boolean isRESTEnabledForPOST()

Description copied from interface: BusinessObject

Return if POST operation is enabled for REST web service

Specified by:

isRESTEnabledForPOST in interface BusinessObject

Returns:

if POST operation is enabled

setRESTEnabledForPUT

public void setRESTEnabledForPUT(boolean enabled)

Description copied from interface: BusinessObject

Set if PUT operation is enabled for REST web service

Specified by:

setRESTEnabledForPUT in interface BusinessObject

Parameters:

enabled - if PUT operation should be enabled

isRESTEnabledForPUT

public boolean isRESTEnabledForPUT()

Description copied from interface: BusinessObject

Return if PUT operation is enabled for REST web service

Specified by:

isRESTEnabledForPUT in interface BusinessObject

Returns:

if PUT operation is enabled

setRESTEnabledForDELETE

public void setRESTEnabledForDELETE(boolean enabled)

Description copied from interface: BusinessObject

Set if DELETE operation is enabled for REST web service

Specified by:

setRESTEnabledForDELETE in interface BusinessObject

Parameters:

enabled - if DELETE operation should be enabled

isRESTEnabledForDELETE

public boolean isRESTEnabledForDELETE()

Description copied from interface: BusinessObject

Return if DELETE operation is enabled for REST web service

Specified by:

isRESTEnabledForDELETE in interface BusinessObject

Returns:

if DELETE operation is enabled

deprecate

public void deprecate()

Description copied from interface: BusinessObject

Deprecate a business object

Specified by:

deprecate in interface BusinessObject

activate

public void activate()

Description copied from interface: BusinessObject

Activate a business object

Specified by:

activate in interface BusinessObject

isDeprecated

public boolean isDeprecated()

Description copied from interface: BusinessObject

Return if a business object is deprecated

Specified by:

isDeprecated in interface BusinessObject

Returns:

if a business object is deprecated

isCustomObject

public boolean isCustomObject()

Description copied from interface: BusinessObject

Return if a business object is a custom object

Specified by:

isCustomObject in interface BusinessObject

Returns:

if a business object is a custom object

isCustomizable

public boolean isCustomizable()

Description copied from interface: BusinessObject

Return if a business object can be customized.

Specified by:

isCustomizable in interface BusinessObject

Returns:

if a business object can be customized

setEnforceUniqueRecordName

public void setEnforceUniqueRecordName(boolean uniqueRecName)

Description copied from interface: BusinessObject

Determines whether a custom business object enforces unique record names

Specified by:

setEnforceUniqueRecordName in interface BusinessObject

Parameters:

uniqueRecName - should it enforce unique record names?

isEnforceUniqueRecordName

public boolean isEnforceUniqueRecordName()

Description copied from interface: BusinessObject

Returns true if a custom business object enforces unique record names

Specified by:

isEnforceUniqueRecordName in interface BusinessObject

Returns:

true if a custom business object enforces unique record names

setCaseSensitiveRecordNameUniqueness

public void setCaseSensitiveRecordNameUniqueness(boolean caseSensitive)

Description copied from interface: BusinessObject

Determines whether a custom business object enforces unique record names in a case-sensitive way.

Specified by:

setCaseSensitiveRecordNameUniqueness in interface BusinessObject

Parameters:

caseSensitive - true if it should enforce case sensitive

isCaseSensitiveRecordNameUniqueness

public boolean isCaseSensitiveRecordNameUniqueness()

Description copied from interface: BusinessObject

Returns true if a custom business object enforces unique record names in a case-sensitive way

Specified by:

isCaseSensitiveRecordNameUniqueness in interface BusinessObject

Returns:

true if a custom business object enforces unique record names in a case-sensitive way

accept

public void accept(ObjectVisitor visitor)

Description copied from interface: BusinessObject

Visitor pattern is implemented for the business object to allow visiting each component of a business object using a custom visitor. By defining a custom visitor that implements ObjectVisitor (or extends BaseObjectVisitor), one can call BusinessObject.accept(visitor) which will transverse all the objects inside a business object.

Specified by:

accept in interface BusinessObject

Parameters:

visitor - The visitor object

getCustomProperties

public java.util.Map<java.lang.String,java.lang.String> getCustomProperties(java.lang.String namespace)

Description copied from interface: BusinessObject

Return a map of custom properties for the attribute with the given namespace

Specified by:

getCustomProperties in interface BusinessObject

Parameters:

namespace - namespace to search for

Returns:

map of custom properties

getCustomProperty

public java.lang.String getCustomProperty(java.lang.String namespace,
                                          java.lang.String name)

Description copied from interface: BusinessObject

Return the value of the custom property with the given namespace and name

Specified by:

getCustomProperty in interface BusinessObject

Parameters:

namespace - namespace to search for

name - name of property to search for

Returns:

value of the custom property

setCustomProperty

public void setCustomProperty(java.lang.String namespace,
                              java.lang.String name,
                              java.lang.String value)

Description copied from interface: BusinessObject

Create or update a custom property of the given namespace and name with the value

Specified by:

setCustomProperty in interface BusinessObject

Parameters:

namespace - namespace for new property

name - name for new property

value - value for new property

setProperty

public void setProperty(java.lang.String hintName,
                        java.lang.Object hintValue,
                        oracle.jbo.LocaleContext locale)

getProperty

public java.lang.Object getProperty(java.lang.String hintName)

getProperty

public java.lang.Object getProperty(java.lang.String hintName,
                                    oracle.jbo.LocaleContext locale)

isPropertyUpdateable

protected boolean isPropertyUpdateable(java.lang.String property)

getOwner

protected oracle.adfinternal.businesseditor.restapi.BaseObject getOwner()

Get the container object that contains this object. This will be null for containers of root level objects such as BusinessEditorManager, LookupManager. It should not return null for all other objects as it is used to construct the ReST request URL path.

Returns:

object that contains this object

getQueryKeys

protected java.lang.String[] getQueryKeys(java.lang.String accessorName)

Different types of objects use different names to find a child object. For example, BusinessEditorManager.findBusinessObject(String name) may use either FullName or just simple Name attribute value of the BusinessObject in the search. LookupManager.findLookupType(String code) will use LookupType attribute as the code.

Parameters:

accessorName - the resource name to reach a particular type of child object

Returns:

attributes whose values are used for matching the parameter in findChild

getFinderKey

protected java.lang.String getFinderKey(java.lang.String accessorName)

Get the key whose value defines the resource name for this object in URL path

Parameters:

accessorName - the resource name to reach a particular type of child object

Returns:

attribute whose value will be used as the resource name of this object

getInternalName

protected final java.lang.String getInternalName()

Name that will represent the resource id for this object. This will be typically the value of the primary/finder key. The name is initialized during constructor of the object based on the JSON structure and the finder key value. This is not necessarily the name returned by getName() or the name that is used to identify the object in a findChild.

Returns:

resource name that represents this object in a ReST URL path

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

Renames this object. It throws BaseObject.ChildAlreadyExists if there is a name clash. Whether the name can be overloaded or not is left to the findChild(Class, Matcher)

Parameters:

name - new name

setDescription

public void setDescription(java.lang.String text)

getDescription

public java.lang.String getDescription()

getAttribute

protected java.lang.Object getAttribute(java.lang.String attrName)

verifyObjectIsValid

protected void verifyObjectIsValid()

Verifies if object is valid. An existing object can become invalid if it is deleted. A newly created object will become invalid if transaction is rolled back before commit.

Throws:

oracle.jbo.JboException - if object is invalid

getAttribute

protected java.lang.Object getAttribute(java.lang.String attrName,
                                        java.lang.Object defaultValue)

Get the attribute value for the given attribute name. Return defaultValue if the value is null.

Parameters:

attrName - name of attribute

defaultValue - default value

Returns:

attribute value of attribute attrName

getLogger

protected oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger getLogger()

setLogger

protected void setLogger(oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger logger)

getState

protected BaseObject.STATE getState()

isNew

public boolean isNew()

setAttribute

protected void setAttribute(java.lang.String attrName,
                            java.lang.Object value)

getMatcher

public BaseObject.Matcher getMatcher()

Get a Matcher that is used to compare with another object. This is different from equals(Object) which does a finer comparision of the whole URL path. For example, functions from global functions or different business objects might match in signature but not equal as their URL path will be different.

Returns:

gets a Matcher that would typically match this object

getChildrenDeleted

protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject> getChildrenDeleted(BaseObject.Matcher childMatcher)

getChildrenNew

protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject> getChildrenNew(BaseObject.Matcher childMatcher)

findChild

protected <T> T findChild(java.lang.String accessorName,
                          java.lang.String childName,
                          java.lang.Class<T> type)

findChild

protected <T> T findChild(java.lang.Class<T> type,
                          BaseObject.Matcher matcher)

findChildren

protected <T> java.util.List<T> findChildren(java.lang.Class<T> type,
                                             BaseObject.Matcher matcher)

Find all children objects matching the given Matcher. This function does not call getChildren() since getChildren() gets an entire list and thus the call can be heavy on network traffic unnecessarily.

Type Parameters:

T - Class that is expected type of the returned children objects.

Parameters:

type - Class instance of type T

matcher - Matcher that is used to find the correct children

Returns:

list of children of given type and matching the given Matcher

getChildrenJSON

protected org.codehaus.jettison.json.JSONArray getChildrenJSON(java.lang.String accessorName)
                                                        throws java.lang.Exception

Get all children of a given type defined by accessorName. The children are in JSON array structure.

Parameters:

accessorName - resource name or type of the children objects

Returns:

array of children in JSON structure

Throws:

java.lang.Exception - if any thrown by the GET request

getChildren

protected <T> java.util.Collection<T> getChildren(java.lang.String accessorName,
                                                  java.lang.Class<T> type)

createChild

protected <T> T createChild(java.lang.String accessorName,
                            java.lang.Class<T> type,
                            org.codehaus.jettison.json.JSONObject obj)

deleteChild

protected void deleteChild(java.lang.String accessorName,
                           java.lang.String childName)

deleteChild

protected void deleteChild(BaseObject.Matcher matcher)

convertToJSON

protected org.codehaus.jettison.json.JSONObject convertToJSON(java.lang.Object... attrNameAndValues)

doDeleteChildren

public void doDeleteChildren()

doCreateNewChildren

public void doCreateNewChildren()

doSetAttributes

public void doSetAttributes()

undoChanges

public void undoChanges()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getLocalizedString

public static java.lang.String getLocalizedString(java.lang.String key,
                                                  java.lang.Object... args)