|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model Business Editor Objects 11g Release 1 (11.1.1.7.0) E36215-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CustomAttribute
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 |
---|
java.lang.String getApiName()
java.lang.String getType()
void setRequiredExpression(java.lang.String value)
value
- the expression to determine if an attribute is required.
oracle.jbo.JboException
- if required expression cannot be set for this attribute type.java.lang.String getRequiredExpression()
void setDisplayWidth(int value)
value
- this display width
oracle.jbo.JboException
- if display width cannot be set for this attribute typeint getDisplayWidth()
void setDisplayHeight(int value)
value
- the display height
oracle.jbo.JboException
- if display height cannot be set for the attribute typeint getDisplayHeight()
void setUpdateable(boolean value)
value
- if this attribute is updateable
oracle.jbo.JboException
- if updateable cannot be set for the attribute typeboolean isUpdateable()
void setSearchable(boolean value)
value
- if this attribute is searchable
oracle.jbo.JboException
- if searchable cannot be set for the attribute type.boolean isSearchable()
void setIndexed(boolean value)
value
- if this attribute is indexed
oracle.jbo.JboException
- if indexed cannot be set for the attribute type.boolean isIndexed()
void setMinLength(int value)
value
- the minimum length
oracle.jbo.JboException
- if minimum length cannot be set for the attribute type.int getMinLength()
void setMaxLength(int value)
value
- the maximum length
oracle.jbo.JboException
- if maximum length cannot be set for the attribute type.int getMaxLength()
void setMinValue(java.math.BigDecimal value)
value
- the minimum value
oracle.jbo.JboException
- if minimum value cannot be set for the attribute type.java.math.BigDecimal getMinValue()
void setMaxValue(java.math.BigDecimal value)
value
- the maximum value
oracle.jbo.JboException
- if maximum value cannot be set for the attribute type.java.math.BigDecimal getMaxValue()
void setDecimalPlace(int value)
value
- the decimal place
oracle.jbo.JboException
- if decimal place cannot be set for the attribute type.int getDecimalPlace()
void setDefaultValue(java.lang.String value)
value
- the default value
oracle.jbo.JboException
- if default value cannot be set for the attribute type.java.lang.String getDefaultValue()
void setExpression(java.lang.String value)
value
- the expression
oracle.jbo.JboException
- if expression cannot be set for the attribute type.java.lang.String getExpression()
boolean isDefaultValueExpression()
void setDatetimeDisplayType(DatetimeDisplayType displayType)
displayType
- the display type
oracle.jbo.JboException
- if display type cannot be set for the attribute type.DatetimeDisplayType getDatetimeDisplayType()
void setMultiselectFixedChoiceList(boolean value)
value
- if the attribute is a multi-select fixed choice list
oracle.jbo.JboException
- if multi-select fixed choice list cannot be set for the attribute type.boolean isMultiselectFixedChoiceList()
void setFixedChoiceListLookupType(java.lang.String value)
value
- the lookup type
oracle.jbo.JboException
- if lookup type of the fixed choice list attribute cannot be set for the attribute type.java.lang.String getFixedChoiceListLookupType()
void setParentChoiceList(Attribute parent, java.util.Map<java.lang.String,java.util.List> valueMap)
parent
- the attribute of the parent choice listvalueMap
- the value mapping between the parent choice list and this attribute
oracle.jbo.JboException
- if the parent attribute specified is not a picklistAttribute getParentChoiceList()
java.util.Map<java.lang.String,java.util.List> getFixedChoiceListValueMap()
void setListDisplayAttribute(Attribute dataSourceAttribute)
dataSourceAttribute
- the list display attributeAttribute getListDisplayAttribute()
void addDisplayAttribute(Attribute attr)
attr
- the attribute to be addedvoid removeDisplayAttr(Attribute attr)
attr
- the attribute to be removedjava.util.List<java.lang.String> getDisplayAttrs()
void addSearchAttribute(Attribute attr)
attr
- the attribute to be addedvoid removeSearchAttr(Attribute attr)
attr
- the attribute to be removedjava.util.List<java.lang.String> getSearchAttrs()
void setFormulaType(FormulaType formulaType)
formulaType
- formula typeFormulaType getFormulaType()
void setProperty(java.lang.String property, java.lang.Object value)
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model Business Editor Objects 11g Release 1 (11.1.1.7.0) E36215-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |