oracle.adf.businesseditor.objects
Interface CustomAttribute

All Superinterfaces:

Attribute

All Known Implementing Classes:

CustomAttributeImpl

public interface CustomAttribute
extends Attribute

A custom attribute for a business object.

Method Summary

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
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<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.
java.lang.String	getFixedChoiceListLookupType() Returns the lookup type of the fixed choice list attribute.
java.util.Map<java.lang.String,java.util.List>	getFixedChoiceListValueMap() Gets the value map if this attribute is a cascading picklist.
FormulaType	getFormulaType() Returns the type of data the expression will be setting as this attribute value.
Attribute	getListDisplayAttribute() Retursn the list display attribute.
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.
Attribute	getParentChoiceList() Gets the parent the choice list that constrains the values in this choice list.
java.lang.String	getRequiredExpression() Returns the expression that determine if this attribute is required.
java.util.List<java.lang.String>	getSearchAttrs() Return list of attributes that are included as search criteria in addition to the selection display value.
java.lang.String	getType() Returns the type of this attribute.
boolean	isDefaultValueExpression() Returns if the default value of this attribute is an expression.
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.
boolean	isUpdateable() Returns if this attribute is updateable
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	setIndexed(boolean value) Sets if this attribute is indexed.
void	setListDisplayAttribute(Attribute dataSourceAttribute) Sets the list display attribute.
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	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	setProperty(java.lang.String property, java.lang.Object value)
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, getDependencyAttrs, getDescription, getDisplayLabel, getHelpText, getName, getTriggers, getUpdateableExpression, getValidators, isRemovable, isRequired, removeDependencyAttr, setDescription, setDisplayLabel, setHelpText, setRequired, setUpdateableExpression

Method Detail

getApiName

java.lang.String getApiName()

Returns the API name of the custom attribte.

Returns:

the API name

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

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

isUpdateable

boolean isUpdateable()

Returns if this attribute is updateable

Returns:

if this attribute is updateable

Throws:

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.

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:

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.

getFixedChoiceListLookupType

java.lang.String getFixedChoiceListLookupType()

Returns the lookup type of the fixed choice list attribute.

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:

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

setListDisplayAttribute

void setListDisplayAttribute(Attribute dataSourceAttribute)

Sets the list display attribute.

Parameters:

dataSourceAttribute - the list display attribute

getListDisplayAttribute

Attribute getListDisplayAttribute()

Retursn the list display attribute.

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

attributes list

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)