oracle.adf.businesseditor.objects

Interface Attribute

All Known Subinterfaces:

CustomAttribute, StandardAttribute

All Known Implementing Classes:

StandardAttributeImpl

public interface Attribute

Base class for StandardAttribute and CustomAttribute. Note that new methods may be added to this interface without notice. Do not extend this interface for custom classes.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependencyAttr(Attribute attr) Adds an attribute as dependency attribute, whose data changes will cause this attribute's constraint expression to be reevaluated.
AttributeTrigger	createTrigger(java.lang.String name, java.lang.String triggerDefinition) Creates a trigger for this attribute.
AttributeTrigger	createTrigger(java.lang.String name, java.lang.String triggerDefinition, java.lang.String errorMessage) Creates a trigger for this attribute.
AttributeValidator	createValidator(java.lang.String name, java.lang.String ruleDefinition, java.lang.String errorMessage) Creates a validator for this attribute.
void	deleteTrigger(AttributeTrigger trigger) Deletes a trigger from this attribute.
void	deleteValidator(AttributeValidator validator) Deletes a validator from this attribute.
AttributeTrigger	findTrigger(java.lang.String name) Retrieve the trigger of the given name.
AttributeValidator	findValidator(java.lang.String name) Retrieve the validator of the given name.
BusinessObject	getBusinessObject() Returns the business object that owns the attribute
java.util.List<Attribute>	getDependencyAttributes() Returns list of dependency attributes for this attribute, whose data changes will cause this attribute's constraint expression to be reevaluated.
java.util.List<java.lang.String>	getDependencyAttrs() Returns list of dependency attributes for this attribute, whose data changes will cause this attribute's constraint expression to be reevaluated.
java.lang.String	getDescription() Returns the description of the object.
java.lang.String	getDisplayLabel() Returns the display label of this attribute.
java.lang.String	getFixedChoiceListLookupType() Returns the fixed choice lookup type if the attribute is defined as a fixed choice list
java.util.Map<java.lang.String,java.util.List>	getFixedChoiceListValueMap() Gets the value map if this attribute is a cascading picklist.
java.lang.String	getHelpText() Returns a description in terms an application will understand.
java.lang.String	getName() Returns the name of the object.
Attribute	getParentChoiceList() Gets the parent the choice list that constrains the values in this choice list.
java.util.Collection<AttributeTrigger>	getTriggers() Retrieve all triggers for this attribute.
java.lang.String	getType() Returns the type of this attribute.
java.lang.String	getUpdateableExpression() Returns the expression that determine if an attribute is updateable.
java.util.Collection<AttributeValidator>	getValidators() Retrieves all validators for the attribute.
boolean	isRemovable() Returns if this attribute is removable.
boolean	isRequired() Returns if value is required for this attribute.
boolean	isUpdateable() Returns if this attribute is updateable
void	removeDependencyAttr(Attribute value) Removes an attribute as dependency attribute, whose data changes will cause this attribute's constraint expression to be reevaluated
void	setDescription(java.lang.String text) Sets the description of the object.
void	setDisplayLabel(java.lang.String displayLabel) Sets the display label of this attribute.
void	setHelpText(java.lang.String helpText) Sets a description in terms an application will understand.
void	setParentChoiceList(Attribute parent, java.util.Map<java.lang.String,java.util.List> valueMap) Sets the parent choice list that constrains the values in this choice list.
void	setRequired(boolean required) Sets if value is required for this attribute.
void	setUpdateableExpression(java.lang.String expression) Registers the expression that control if this attribute is updateable.

Method Detail

getName

java.lang.String getName()

Returns the name of the object.

Returns:

the name of the object

Throws:

getType

java.lang.String getType()

Returns the type of this attribute. Values includes Checkbox, Lookup, Picklist, Text, Number, Date, Datetime, Formula, Percentage, or custom type.

Returns:

type of this attribute

getValidators

java.util.Collection<AttributeValidator> getValidators()

Retrieves all validators for the attribute.

Returns:

collection of validators

findValidator

AttributeValidator findValidator(java.lang.String name)

Retrieve 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

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

Creates a validator for this attribute.

Parameters:

name - name of the validator.

ruleDefinition - validator definition

Returns:

the validator created

Throws:

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

deleteValidator

void deleteValidator(AttributeValidator validator)

Deletes a validator from this attribute.

Parameters:

validator - the validator to be deleted

Throws:

JboException - if an validator is not provided.

getTriggers

java.util.Collection<AttributeTrigger> getTriggers()

Retrieve all triggers for this attribute.

Returns:

collection of triggers

findTrigger

AttributeTrigger 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

AttributeTrigger createTrigger(java.lang.String name,
                             java.lang.String triggerDefinition)

Creates a trigger for this attribute.

Parameters:

name - name of the trigger.

triggerDefinition - trigger definition of the trigger

Returns:

the trigger created for the type and name.

Throws:

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

createTrigger

AttributeTrigger createTrigger(java.lang.String name,
                             java.lang.String triggerDefinition,
                             java.lang.String errorMessage)

Creates a trigger for this attribute.

Parameters:

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:

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

deleteTrigger

void deleteTrigger(AttributeTrigger trigger)

Deletes a trigger from this attribute.

Parameters:

trigger - the trigger to be deleted

Throws:

JboException - if an trigger is not provided.

setUpdateableExpression

void setUpdateableExpression(java.lang.String expression)

Registers the expression that control if this attribute is updateable.

Parameters:

expression - the expression to control if this attribute is updateable.

Throws:

JboException - if updateable expression cannot be set for the attribute type.

getUpdateableExpression

java.lang.String getUpdateableExpression()

Returns the expression that determine if an attribute is updateable.

Returns:

the expression to determine if an attribute is updateable.

addDependencyAttr

void addDependencyAttr(Attribute attr)

Adds an attribute as dependency attribute, whose data changes will cause this attribute's constraint expression to be reevaluated.

Parameters:

attr - the new dependent attribute

removeDependencyAttr

void removeDependencyAttr(Attribute value)

Removes an attribute as dependency attribute, whose data changes will cause this attribute's constraint expression to be reevaluated

Parameters:

value - the dependent attribute to be removed

getDependencyAttrs

java.util.List<java.lang.String> getDependencyAttrs()

Returns list of dependency attributes for this attribute, whose data changes will cause this attribute's constraint expression to be reevaluated.

Returns:

list of dependency attributes

getDependencyAttributes

java.util.List<Attribute> getDependencyAttributes()

Returns list of dependency attributes for this attribute, whose data changes will cause this attribute's constraint expression to be reevaluated.

Returns:

list of dependency attributes

setDisplayLabel

void setDisplayLabel(java.lang.String displayLabel)

Sets the display label of this attribute.

Parameters:

displayLabel - display label of this attribute

getDisplayLabel

java.lang.String getDisplayLabel()

Returns the display label of this attribute.

Returns:

the display label of this attribute

setHelpText

void setHelpText(java.lang.String helpText)

Sets a description in terms an application will understand.

Parameters:

helpText - a description

getHelpText

java.lang.String getHelpText()

Returns a description in terms an application will understand.

Returns:

a description

Throws:

setDescription

void setDescription(java.lang.String text)

Sets the description of the object.

Parameters:

text - description of the object

Throws:

getDescription

java.lang.String getDescription()

Returns the description of the object.

Returns:

the description of the object

Throws:

setRequired

void setRequired(boolean required)

Sets if value is required for this attribute.

Parameters:

required - if valud is required for this attribute

isRequired

boolean isRequired()

Returns if value is required for this attribute.

Returns:

if value is required for this attribute.

isRemovable

boolean isRemovable()

Returns if this attribute is removable.

Returns:

if this attribute is removable

getFixedChoiceListLookupType

java.lang.String getFixedChoiceListLookupType()

Returns the fixed choice lookup type if the attribute is defined as a fixed choice list

Returns:

the lookup type of the fixed choice list attribute

Throws:

setParentChoiceList

void setParentChoiceList(Attribute parent,
                       java.util.Map<java.lang.String,java.util.List> valueMap)

Sets the parent choice list that constrains the values in this choice list.

Parameters:

parent - the attribute of the parent choice list

valueMap - the value mapping between the parent choice list and this attribute

Throws:

JboException - if the parent attribute specified is not a picklist

getParentChoiceList

Attribute getParentChoiceList()

Gets the parent the choice list that constrains the values in this choice list.

Returns:

the attribute of the parent choice list

getFixedChoiceListValueMap

java.util.Map<java.lang.String,java.util.List> getFixedChoiceListValueMap()

Gets the value map if this attribute is a cascading picklist.

Returns:

the value map between the parent choice list and this attribute

getBusinessObject

BusinessObject getBusinessObject()

Returns the business object that owns the attribute

Returns:

the business object

isUpdateable

boolean isUpdateable()

Returns if this attribute is updateable

Returns:

if this attribute is updateable

Throws: