oracle.adf.businesseditor.objects

Interface CustomAttribute

All Superinterfaces:

Attribute

public interface CustomAttribute
extends Attribute

A custom attribute for a business object. 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	activate() Activate an attribute
void	addDisplayAttribute(Attribute attr) Adds an attribute to be included in the List of Values window for context.
void	addSearchAttribute(Attribute attr) Adds an attribute to be included as search criteria in addition to the selection display value.
void	deprecate() Deprecate an attribute
java.lang.String	getApiName() Returns the API name of the custom attribte.
DatetimeDisplayType	getDatetimeDisplayType() Returns the display type of this attribute.
int	getDecimalPlace() Returns the decimal place of this attribute
java.lang.String	getDefaultValue() Returns the default value of this attribute.
java.util.List<Attribute>	getDisplayAttributes() Returns list of display attributes that is included in the List of Values window for context.
java.util.List<java.lang.String>	getDisplayAttrs() Returns list of display attributes that is included in the List of Values window for context.
int	getDisplayHeight() Returns the display height of this attribute.
int	getDisplayWidth() Returns the display width of this attribute.
java.lang.String	getExpression() Returns the expression of this attribute.
FormulaType	getFormulaType() Returns the type of data the expression will be setting as this attribute value.
Attribute	getListDisplayAttribute() Retursn the list display attribute used by a dynamic choice list.
int	getMaxLength() Returns the maximum length of this attribute.
java.math.BigDecimal	getMaxValue() Returns the maximum value of this attribute.
int	getMinLength() Returns the minimum length of this attribute.
java.math.BigDecimal	getMinValue() Returns the minimum value of this attribute.
java.lang.String	getRequiredExpression() Returns the expression that determine if this attribute is required.
java.util.List<Attribute>	getSearchAttributes() Return list of attributes that are included as search criteria in addition to the selection display value.
java.util.List<java.lang.String>	getSearchAttrs() Return list of attributes that are included as search criteria in addition to the selection display value.
boolean	isDefaultValueExpression() Returns if the default value of this attribute is an expression.
boolean	isDeprecated() Return if an attribute is deprecated
boolean	isIncludedInServicePayload() Returns if this attribute is included in the service payload
boolean	isIndexed() Returns if the attribute is indexed.
boolean	isMultiselectFixedChoiceList() Returns if this attribute is a multi-select fixed choice list.
boolean	isSearchable() Returns if this attribute is searchable.
void	removeDisplayAttr(Attribute attr) Removes an attribute from being included in the List of Values window for context.
void	removeSearchAttr(Attribute attr) Removes an attribute from being included as search criteria in addition to the selection display value.
void	setDatetimeDisplayType(DatetimeDisplayType displayType) Sets the display type of a Datetime attribute.
void	setDecimalPlace(int value) Sets the decimal place of this attribute.
void	setDefaultValue(java.lang.String value) Sets the default value of this attribute.
void	setDisplayHeight(int value) Sets the display height of this attribute.
void	setDisplayWidth(int value) Sets the display width of this attribute.
void	setExpression(java.lang.String value) Sets the expression of this attribute.
void	setFixedChoiceListLookupType(java.lang.String value) Sets the lookup type of the fixed choice list attribute.
void	setFormulaType(FormulaType formulaType) Sets the type of data the expression will be setting as this attribute value.
void	setIncludedInServicePayload(boolean value) Sets if this attribute is included in the service payload
void	setIndexed(boolean value) Sets if this attribute is indexed.
void	setListDisplayAttribute(Attribute dataSourceAttribute) Sets the list display attribute to be used by a dynamic choice list.
void	setMaxLength(int value) Sets the maximum length of this attribute.
void	setMaxValue(java.math.BigDecimal value) Sets the maximum value of this attribute.
void	setMinLength(int value) Sets the minimum length of this attribute.
void	setMinValue(java.math.BigDecimal value) Sets the minimum value of this attribute.
void	setMultiselectFixedChoiceList(boolean value) Sets if the attribute is a multi-select fixed choice list.
void	setProperty(java.lang.String property, java.lang.Object value) Assign a value to a property for the attribute
void	setRequiredExpression(java.lang.String value) Sets the expression that determine if an attribute is required.
void	setSearchable(boolean value) Sets if this attribute is searchable.
void	setUpdateable(boolean value) Sets if the attribute is updateable.

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

addDependencyAttr, createTrigger, createTrigger, createValidator, deleteTrigger, deleteValidator, findTrigger, findValidator, getBusinessObject, getDependencyAttributes, getDependencyAttrs, getDescription, getDisplayLabel, getFixedChoiceListLookupType, getFixedChoiceListValueMap, getHelpText, getName, getParentChoiceList, getTriggers, getType, getUpdateableExpression, getValidators, isRemovable, isRequired, isUpdateable, removeDependencyAttr, setDescription, setDisplayLabel, setHelpText, setParentChoiceList, setRequired, setUpdateableExpression

Method Detail

getApiName

java.lang.String getApiName()

Returns the API name of the custom attribte.

Returns:

the API name

setRequiredExpression

void setRequiredExpression(java.lang.String value)

Sets the expression that determine if an attribute is required.

Parameters:

value - the expression to determine if an attribute is required.

Throws:

oracle.jbo.JboException - if required expression cannot be set for this attribute type.

getRequiredExpression

java.lang.String getRequiredExpression()

Returns the expression that determine if this attribute is required.

Returns:

the expression to determine if this attribute is required.

Throws:

setDisplayWidth

void setDisplayWidth(int value)

Sets the display width of this attribute.

Parameters:

value - this display width

Throws:

oracle.jbo.JboException - if display width cannot be set for this attribute type

getDisplayWidth

int getDisplayWidth()

Returns the display width of this attribute.

Returns:

the display width. If display width is not set, -1 is returned

Throws:

setDisplayHeight

void setDisplayHeight(int value)

Sets the display height of this attribute.

Parameters:

value - the display height

Throws:

oracle.jbo.JboException - if display height cannot be set for the attribute type

getDisplayHeight

int getDisplayHeight()

Returns the display height of this attribute.

Returns:

the display height. If display height is not set, -1 is returned

Throws:

setUpdateable

void setUpdateable(boolean value)

Sets if the attribute is updateable.

Parameters:

value - if this attribute is updateable

Throws:

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

setSearchable

void setSearchable(boolean value)

Sets if this attribute is searchable.

Parameters:

value - if this attribute is searchable

Throws:

oracle.jbo.JboException - if searchable cannot be set for the attribute type.

isSearchable

boolean isSearchable()

Returns if this attribute is searchable.

Returns:

if this attribute is searchable

Throws:

setIndexed

void setIndexed(boolean value)

Sets if this attribute is indexed.

Parameters:

value - if this attribute is indexed

Throws:

oracle.jbo.JboException - if indexed cannot be set for the attribute type.

isIndexed

boolean isIndexed()

Returns if the attribute is indexed.

Returns:

if the attribute is indexed

Throws:

setMinLength

void setMinLength(int value)

Sets the minimum length of this attribute.

Parameters:

value - the minimum length

Throws:

oracle.jbo.JboException - if minimum length cannot be set for the attribute type.

getMinLength

int getMinLength()

Returns the minimum length of this attribute.

Returns:

the minimum length. If minimum length is not set, -1 is returned.

Throws:

setMaxLength

void setMaxLength(int value)

Sets the maximum length of this attribute.

Parameters:

value - the maximum length

Throws:

oracle.jbo.JboException - if maximum length cannot be set for the attribute type.

getMaxLength

int getMaxLength()

Returns the maximum length of this attribute.

Returns:

the maximum length. If maximum length is not set, null is returned.

Throws:

setMinValue

void setMinValue(java.math.BigDecimal value)

Sets the minimum value of this attribute.

Parameters:

value - the minimum value

Throws:

oracle.jbo.JboException - if minimum value cannot be set for the attribute type.

getMinValue

java.math.BigDecimal getMinValue()

Returns the minimum value of this attribute.

Returns:

the minimum value. If minimum value is not set, null is returned.

Throws:

setMaxValue

void setMaxValue(java.math.BigDecimal value)

Sets the maximum value of this attribute.

Parameters:

value - the maximum value

Throws:

oracle.jbo.JboException - if maximum value cannot be set for the attribute type.

getMaxValue

java.math.BigDecimal getMaxValue()

Returns the maximum value of this attribute.

Returns:

the maximum value. If maximum value is not set, -1 is returned.

Throws:

setDecimalPlace

void setDecimalPlace(int value)

Sets the decimal place of this attribute.

Parameters:

value - the decimal place

Throws:

oracle.jbo.JboException - if decimal place cannot be set for the attribute type.

getDecimalPlace

int getDecimalPlace()

Returns the decimal place of this attribute

Returns:

the decimal place. If decimal place is not set, -1 is returned.

Throws:

setDefaultValue

void setDefaultValue(java.lang.String value)

Sets the default value of this attribute. To specify multiple default values for a picklist, provide the default values in a comma separated list.

Parameters:

value - the default value

Throws:

oracle.jbo.JboException - if default value cannot be set for the attribute type.

getDefaultValue

java.lang.String getDefaultValue()

Returns the default value of this attribute.

Returns:

the default value

Throws:

setExpression

void setExpression(java.lang.String value)

Sets the expression of this attribute.

Parameters:

value - the expression

Throws:

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

getExpression

java.lang.String getExpression()

Returns the expression of this attribute.

Returns:

the expression

Throws:

isDefaultValueExpression

boolean isDefaultValueExpression()

Returns if the default value of this attribute is an expression.

Returns:

if the default value of this attribute is an expression

Throws:

setDatetimeDisplayType

void setDatetimeDisplayType(DatetimeDisplayType displayType)

Sets the display type of a Datetime attribute. Valid values are "Time", "Date", and "both".

Parameters:

displayType - the display type

Throws:

oracle.jbo.JboException - if display type cannot be set for the attribute type.

getDatetimeDisplayType

DatetimeDisplayType getDatetimeDisplayType()

Returns the display type of this attribute.

Returns:

the display type

Throws:

setMultiselectFixedChoiceList

void setMultiselectFixedChoiceList(boolean value)

Sets if the attribute is a multi-select fixed choice list.

Parameters:

value - if the attribute is a multi-select fixed choice list

Throws:

oracle.jbo.JboException - if multi-select fixed choice list cannot be set for the attribute type.

isMultiselectFixedChoiceList

boolean isMultiselectFixedChoiceList()

Returns if this attribute is a multi-select fixed choice list.

Returns:

if this attribute is a multi-select fixed choice list

Throws:

setIncludedInServicePayload

void setIncludedInServicePayload(boolean value)

Sets if this attribute is included in the service payload

Parameters:

value - if this attribute is included in the service payload

isIncludedInServicePayload

boolean isIncludedInServicePayload()

Returns if this attribute is included in the service payload

Returns:

if this attribute is included in the service payload

Throws:

setFixedChoiceListLookupType

void setFixedChoiceListLookupType(java.lang.String value)

Sets the lookup type of the fixed choice list attribute.

Parameters:

value - the lookup type

Throws:

oracle.jbo.JboException - if lookup type of the fixed choice list attribute cannot be set for the attribute type.

setListDisplayAttribute

void setListDisplayAttribute(Attribute dataSourceAttribute)

Sets the list display attribute to be used by a dynamic choice list.

Parameters:

dataSourceAttribute - the list display attribute

getListDisplayAttribute

Attribute getListDisplayAttribute()

Retursn the list display attribute used by a dynamic choice list.

Returns:

the list display attribute

addDisplayAttribute

void addDisplayAttribute(Attribute attr)

Adds an attribute to be included in the List of Values window for context.

Parameters:

attr - the attribute to be added

removeDisplayAttr

void removeDisplayAttr(Attribute attr)

Removes an attribute from being included in the List of Values window for context.

Parameters:

attr - the attribute to be removed

getDisplayAttrs

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

Returns list of display attributes that is included in the List of Values window for context.

Returns:

list of display attribute names

getDisplayAttributes

java.util.List<Attribute> getDisplayAttributes()

Returns list of display attributes that is included in the List of Values window for context.

Returns:

list of display attributes

addSearchAttribute

void addSearchAttribute(Attribute attr)

Adds an attribute to be included as search criteria in addition to the selection display value.

Parameters:

attr - the attribute to be added

removeSearchAttr

void removeSearchAttr(Attribute attr)

Removes an attribute from being included as search criteria in addition to the selection display value.

Parameters:

attr - the attribute to be removed

getSearchAttrs

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

Return list of attributes that are included as search criteria in addition to the selection display value.

Returns:

list of attribute names

getSearchAttributes

java.util.List<Attribute> getSearchAttributes()

Return list of attributes that are included as search criteria in addition to the selection display value.

Returns:

list of attributes

setFormulaType

void setFormulaType(FormulaType formulaType)

Sets the type of data the expression will be setting as this attribute value.

Parameters:

formulaType - formula type

getFormulaType

FormulaType getFormulaType()

Returns the type of data the expression will be setting as this attribute value.

Returns:

formula type

setProperty

void setProperty(java.lang.String property,
               java.lang.Object value)

Assign a value to a property for the attribute

Parameters:

property - the name of the property to be updated

value - the value of the property

deprecate

void deprecate()

Deprecate an attribute

activate

void activate()

Activate an attribute

isDeprecated

boolean isDeprecated()

Return if an attribute is deprecated

Returns:

if an attribute is deprecated