oracle.adf.businesseditor.objects

Interface BusinessObject

All Known Implementing Classes:

BusinessObjectImpl

public interface BusinessObject

A business object can be customizable or reference-only. For reference-only business objects, findAttribute(java.lang.String) can be used to retrieve the attributes that can be used as list display and search attribute for dymanic choice list. No other methods are supported. Use isCustomizable() to identify if a business object is customizable. Note that new methods may be added to this interface without notice. Do not extend this interface for custom classes.

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
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.
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.
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
Attribute	findAttribute(java.lang.String name) Retrive the attribute of the given name.
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.
java.lang.String	getAPIName() Returns the API name of the object.
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.
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() Returns the description of the object.
java.lang.String	getDisplayLabel() Returns the display label of the object.
java.lang.String	getDisplayNamePlural() Returns the plural display label of the object.
java.lang.String	getFullName() Returns the full name of the object.
java.util.Collection<BusinessObjectFunction>	getFunctions() Retrieve all functions for the business object.
java.lang.String	getName() Returns the name of the object.
BusinessObject	getParent() Return the parent object if the business object is 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.
java.util.Collection<BusinessObjectTrigger>	getTriggers() Retrieve all triggers for this business object.
java.util.Collection<BusinessObjectValidator>	getValidators() Retrieve all validators for this business 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	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
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 description) Set the description of the object.
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
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.

Method Detail

getAttributes

java.util.Collection<Attribute> getAttributes()

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 isCustomizable() to identify if a business object is customizable.

Returns:

collection of attributes

getStandardAttributes

java.util.Collection<StandardAttribute> getStandardAttributes()

Retrieve all standard attributes for this business object.

Returns:

collection of standard attributes

getCustomAttributes

java.util.Collection<CustomAttribute> getCustomAttributes()

Retrieve all custom attributes for this business object.

Returns:

collection of custom attributes

findAttribute

Attribute findAttribute(java.lang.String name)

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.

Parameters:

name - name of the attribute.

Returns:

attribute with the given name

createAttribute

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

Create a custom attribute for the given name and type.

Parameters:

name - name of the attribute

attrType - type of the attribute in AttributeType

Returns:

the custom attribute created for the name and type.

Throws:

oracle.jbo.JboException - if an attribute for the given name already exists.

createAttribute

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

Create a custom attribute for the given name and type.

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.

Throws:

oracle.jbo.JboException - if an attribute for the given name already exists.

deleteAttribute

void deleteAttribute(CustomAttribute attr)

Delete a custom attribute.

Parameters:

attr - custom attribute to be deleted

Throws:

oracle.jbo.JboException - if attribute is null or if attribute cannot be deleted

getValidators

java.util.Collection<BusinessObjectValidator> getValidators()

Retrieve all validators for this business object.

Returns:

collection of validators

findValidator

BusinessObjectValidator findValidator(java.lang.String name)

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

Parameters:

name - name of the validator.

Returns:

validator with the given name

createValidator

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

Create a validator for this business object.

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.

Throws:

oracle.jbo.JboException - if an validator for the given name already exists.

deleteValidator

void deleteValidator(BusinessObjectValidator validator)

Delete a validator from this business object.

Parameters:

validator - name of the validator

Throws:

oracle.jbo.JboException - if validator is null.

getTriggers

java.util.Collection<BusinessObjectTrigger> getTriggers()

Retrieve all triggers for this business object.

Returns:

collection of triggers

findTrigger

BusinessObjectTrigger findTrigger(java.lang.String name)

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

Parameters:

name - name of the trigger.

Returns:

trigger with the given name

createTrigger

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

Create a trigger for this business object.

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.

Throws:

oracle.jbo.JboException - if an trigger for the given name already exists.

deleteTrigger

void deleteTrigger(BusinessObjectTrigger trigger)

Delete a trigger from this business object.

Parameters:

trigger - name of the trigger

Throws:

oracle.jbo.JboException - if an trigger is null

getFunctions

java.util.Collection<BusinessObjectFunction> getFunctions()

Retrieve all functions for the business object.

Returns:

collection of functions

findFunction

BusinessObjectFunction findFunction(java.lang.String name,
                                    java.lang.String... paramTypes)

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.

Parameters:

name - name of the business object function to be returned

paramTypes - parameter types for function

Returns:

business object function

findFunctions

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

Retrieves all functions with the name for the business object.

Parameters:

name - name of the functions to be returned

Returns:

business object functions

createFunction

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

Create a function for this business object.

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.

Throws:

oracle.jbo.JboException - if an function for the given name already exists.

deleteFunction

void deleteFunction(BusinessObjectFunction function)

Delete a function from this business object.

Parameters:

function - function to be deleted

Throws:

oracle.jbo.JboException - if function is null

setDisplayLabel

void setDisplayLabel(java.lang.String text)

Set the display label of the object.

Parameters:

text - display label of the object

getDisplayLabel

java.lang.String getDisplayLabel()

Returns the display label of the object.

Returns:

the display label of the object

setDisplayNamePlural

void setDisplayNamePlural(java.lang.String value)

Set the plural display label of the object.

Parameters:

value - plural display label of the object

getDisplayNamePlural

java.lang.String getDisplayNamePlural()

Returns the plural display label of the object.

Returns:

the plural display label of the object

setRecordNameLabel

void setRecordNameLabel(java.lang.String value)

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

Parameters:

value - record name label of the object

getRecordNameLabel

java.lang.String getRecordNameLabel()

Returns the record name label of the object.

Returns:

the record name label of the object

setSortBy

void setSortBy(Attribute attribute,
               boolean ascending)

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

Parameters:

attribute - sort by attribute on the object

ascending - sort direction, ascending or descending.

getSortByAttribute

Attribute getSortByAttribute()

Returns the sort by attribute of the object.

Returns:

the sort by attribute of the object

isSortByAscending

boolean isSortByAscending()

Returns the sort by direction of the object.

Returns:

the sort by direction of the object

setAutoNumberPattern

void setAutoNumberPattern(java.lang.String value)

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

Parameters:

value - auto number pattern of the object

getAutoNumberPattern

java.lang.String getAutoNumberPattern()

Returns the auto number pattern of the object.

Returns:

the auto number pattern of the object

getName

java.lang.String getName()

Returns the name of the object.

Returns:

the name of the object

setDescription

void setDescription(java.lang.String description)

Set the description of the object.

Parameters:

description - new description to use for object

getDescription

java.lang.String getDescription()

Returns the description of the object.

Returns:

the description of the object

getFullName

java.lang.String getFullName()

Returns the full name of the object.

Returns:

the full name of the object

getAPIName

java.lang.String getAPIName()

Returns the API name of the object.

Returns:

the API name of the object

getParent

BusinessObject getParent()

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

Returns:

the parent object if exists

setChildCollectionName

void setChildCollectionName(java.lang.String childCollectionName)

Set the name of the child object records set

Parameters:

childCollectionName - the name of the child object records set

getChildCollectionName

java.lang.String getChildCollectionName()

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.

Returns:

the internal name of the child object records set

isRemovable

boolean isRemovable()

Return if business object is removable.

Returns:

if business object is removable

publishRESTWebService

void publishRESTWebService()

Publish REST web service for the custom object

depublishRESTWebService

void depublishRESTWebService()

Depublish REST web service for the custom object

isRESTWebServicePublished

boolean isRESTWebServicePublished()

Return if REST web service is published for the business object

Returns:

if REST web service is published

setRESTEnabledForGET

void setRESTEnabledForGET(boolean enabled)

Set if GET operation is enabled for REST web service

Parameters:

enabled - if GET operation should be enabled

isRESTEnabledForGET

boolean isRESTEnabledForGET()

Return if GET operation is enabled for REST web service

Returns:

if GET operation is enabled

setRESTEnabledForPOST

void setRESTEnabledForPOST(boolean enabled)

Set if POST operation is enabled for REST web service

Parameters:

enabled - if POST operation should be enabled

isRESTEnabledForPOST

boolean isRESTEnabledForPOST()

Return if POST operation is enabled for REST web service

Returns:

if POST operation is enabled

setRESTEnabledForPUT

void setRESTEnabledForPUT(boolean enabled)

Set if PUT operation is enabled for REST web service

Parameters:

enabled - if PUT operation should be enabled

isRESTEnabledForPUT

boolean isRESTEnabledForPUT()

Return if PUT operation is enabled for REST web service

Returns:

if PUT operation is enabled

setRESTEnabledForDELETE

void setRESTEnabledForDELETE(boolean enabled)

Set if DELETE operation is enabled for REST web service

Parameters:

enabled - if DELETE operation should be enabled

isRESTEnabledForDELETE

boolean isRESTEnabledForDELETE()

Return if DELETE operation is enabled for REST web service

Returns:

if DELETE operation is enabled

deprecate

void deprecate()

Deprecate a business object

activate

void activate()

Activate a business object

isDeprecated

boolean isDeprecated()

Return if a business object is deprecated

Returns:

if a business object is deprecated

isCustomObject

boolean isCustomObject()

Return if a business object is a custom object

Returns:

if a business object is a custom object

isEnforceUniqueRecordName

boolean isEnforceUniqueRecordName()

Returns true if a custom business object enforces unique record names

Returns:

true if a custom business object enforces unique record names

setCaseSensitiveRecordNameUniqueness

void setCaseSensitiveRecordNameUniqueness(boolean caseSensitive)

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

Parameters:

caseSensitive - true if it should enforce case sensitive

isCaseSensitiveRecordNameUniqueness

boolean isCaseSensitiveRecordNameUniqueness()

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

Returns:

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

setEnforceUniqueRecordName

void setEnforceUniqueRecordName(boolean uniqueRecName)

Determines whether a custom business object enforces unique record names

Parameters:

uniqueRecName - should it enforce unique record names?

accept

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. 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.

Parameters:

visitor - The visitor object

isCustomizable

boolean isCustomizable()

Return if a business object can be customized.

Returns:

if a business object can be customized

getCustomProperties

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

Parameters:

namespace - namespace to search for

Returns:

map of custom properties

getCustomProperty

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

Parameters:

namespace - namespace to search for

name - name of property to search for

Returns:

value of the custom property

setCustomProperty

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

Parameters:

namespace - namespace for new property

name - name for new property

value - value for new property