oracle.adf.businesseditor.objects
Interface BusinessObject

All Known Implementing Classes:

BusinessObjectImpl

public interface BusinessObject

A business object.

Method Summary

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(oracle.jbo.server.TriggerType 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.
Attribute	findAttribute(java.lang.String name) Retrive the attribute of the given name.
BusinessObjectFunction	findFunction(java.lang.String name) Retrive the function of the given name.
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.util.Collection<Attribute>	getAttributes() Retrieve all attributes for this business object.
java.lang.String	getAutoNumberPattern() Returns the auto number pattern of the object.
java.util.Collection<CustomAttribute>	getCustomAttributes() Retrieve all custom attributes for this business object.
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.
java.lang.String	getRecordNameLabel() Returns the record name label 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	isRemovable() Return if business object is removable.
void	setAutoNumberPattern(java.lang.String value) Set the auto number pattern of the object.
void	setDescription(java.lang.String description) Returns 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	setRecordNameLabel(java.lang.String value) Set the record name label of the object.

Method Detail

getAttributes

java.util.Collection<Attribute> getAttributes()

Retrieve all attributes for this business object.

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.

Parameters:

name - name of the attribute.

Returns:

attribute with the given name

Throws:

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

Throws:

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

Throws:

createTrigger

BusinessObjectTrigger createTrigger(oracle.jbo.server.TriggerType 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)

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

Parameters:

name - name of the function.

Returns:

function with the given name

Throws:

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

Throws:

getDisplayLabel

java.lang.String getDisplayLabel()

Returns the display label of the object.

Returns:

the display label of the object

Throws:

setDisplayNamePlural

void setDisplayNamePlural(java.lang.String value)

Set the plural display label of the object.

Parameters:

value - plural display label of the object

Throws:

getDisplayNamePlural

java.lang.String getDisplayNamePlural()

Returns the plural display label of the object.

Returns:

the plural display label of the object

Throws:

setRecordNameLabel

void setRecordNameLabel(java.lang.String value)

Set the record name label of the object.

Parameters:

value - record name label of the object

Throws:

oracle.jbo.JboException - if it is not a custom business object

getRecordNameLabel

java.lang.String getRecordNameLabel()

Returns the record name label of the object.

Returns:

the record name label of the object

Throws:

setAutoNumberPattern

void setAutoNumberPattern(java.lang.String value)

Set the auto number pattern of the object.

Parameters:

value - auto number pattern of the object

Throws:

oracle.jbo.JboException - if it is not a custom business object

getAutoNumberPattern

java.lang.String getAutoNumberPattern()

Returns the auto number pattern of the object.

Returns:

the auto number pattern of the object

Throws:

getName

java.lang.String getName()

Returns the name of the object.

Returns:

the name of the object

Throws:

setDescription

void setDescription(java.lang.String description)

Returns the description of the object.

Throws:

getDescription

java.lang.String getDescription()

Returns the description of the object.

Returns:

the description of the object

Throws:

getFullName

java.lang.String getFullName()

Returns the full name of the object.

Returns:

the full name of the object

Throws:

isRemovable

boolean isRemovable()

Return if business object is removable.

Returns:

if business object is removable