Oracle Fusion Middleware Java API Reference for Oracle ADF Model Business Editor Objects
11g Release 1 (11.1.1.7.0)

E36215-01

oracle.adfinternal.businesseditor.objects
Class CustomAttributeImpl

java.lang.Object
  extended by oracle.adfinternal.businesseditor.objects.BusinessEditorBaseObjectImpl
      extended by oracle.adfinternal.businesseditor.objects.BusinessEditorObjectImpl
          extended by oracle.adfinternal.businesseditor.objects.AttributeImpl
              extended by oracle.adfinternal.businesseditor.objects.CustomAttributeImpl
All Implemented Interfaces:
Attribute, CustomAttribute, ObjectGroupOwner

public final class CustomAttributeImpl
extends AttributeImpl
implements CustomAttribute

For internal framework use only. A custom attribute for a business object.

For internal use only. Application developers should not use this

Constructor Summary
protected CustomAttributeImpl(BusinessObjectImpl bo, java.lang.String attrName, java.lang.String type)
           
 
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
protected  void cancelFlowForExistingObject()
           
protected  void cancelFlowForNewObject()
           
protected  void doRollback()
           
protected  void finishFlowForExistingObject()
           
protected  void finishFlowForNewObject()
           
 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.
 AttributeImpl getListDisplayAttribute()
          Retursn the list display attribute.
protected  java.lang.String getLogicalType()
           
 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.
protected  ObjectType getObjectType()
           
 AttributeImpl 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.
protected  oracle.jbo.ViewObject getViewObjectBeingEdited()
           
protected  void initFlowForExistingObject()
           
protected  void initFlowForNewObject()
           
protected  void initialize()
           
 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.
protected  boolean isPropertyUpdateable(java.lang.String property)
           
 boolean isRemovable()
          Returns if this attribute is removable.
 boolean isSearchable()
          Returns if this attribute is searchable.
 boolean isUpdateable()
          Returns if this attribute is updateable
protected  void postCommit()
           
protected  void preCommit()
           
 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)
           
protected  void setProperty(java.lang.String property, java.lang.Object value, boolean checkUpdateable)
           
protected  void setProperty(java.lang.String property, java.lang.Object value, java.lang.String propertyUpdateable)
           
 void setRequired(boolean value)
          Sets if value is required for this 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.
 void setUpdateableExpression(java.lang.String value)
          Registers the expression that control if this attribute is updateable.
protected  void writeObject(oracle.jbo.Row object)
           
 
Methods inherited from class oracle.adfinternal.businesseditor.objects.AttributeImpl
addAttrToList, addDependencyAttr, addTrigger, createTrigger, createTrigger, createValidator, deleteTrigger, deleteValidator, doCommit, findTrigger, findValidator, getBusinessObjectFullName, getDependencyAttrs, getDisplayLabel, getGroupHelper, getHelpText, getTriggers, getUpdateableExpression, getValidators, isRequired, removeAttrFromList, removeDependencyAttr, renameTrigger, renameValidator, setDisplayLabel, setHelpText, setTriggerPopulated
 
Methods inherited from class oracle.adfinternal.businesseditor.objects.BusinessEditorObjectImpl
getBusinessEditor, getBusinessEditorLogic, getBusinessEditorManager, getBusinessEditorViewLogic, getDescription, getName, getObjectKey, getProperty, setDescription, setName
 
Methods inherited from class oracle.adfinternal.businesseditor.objects.BusinessEditorBaseObjectImpl
canPopulateChildren, checkLoadObject, containsProperty, ensureVerified, getContainer, getLocalizedString, getPropertyNoLoad, isLoaded, isNew, isNotVerified, populateChildren, readObject, removeProperty, setDirty, setNew, setNotExist, setPropertyNoLoad, setVerified, valuesDiffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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, isRequired, removeDependencyAttr, setDescription, setDisplayLabel, setHelpText
 

Constructor Detail

CustomAttributeImpl

protected CustomAttributeImpl(BusinessObjectImpl bo,
                              java.lang.String attrName,
                              java.lang.String type)
Method Detail

getApiName

public java.lang.String getApiName()
Description copied from interface: CustomAttribute
Returns the API name of the custom attribte.

Specified by:
getApiName in interface CustomAttribute
Overrides:
getApiName in class AttributeImpl
Returns:
the API name

getType

public java.lang.String getType()
Description copied from interface: CustomAttribute
Returns the type of this attribute. Values includes Checkbox, Lookup, Picklist, Text, Number, Date, Datetime, Formula, Percentage, or custom type.

Specified by:
getType in interface CustomAttribute
Returns:
type of this attribute

setRequired

public void setRequired(boolean value)
Description copied from interface: Attribute
Sets if value is required for this attribute.

Specified by:
setRequired in interface Attribute
Overrides:
setRequired in class AttributeImpl
Parameters:
value - if valud is required for this attribute

setRequiredExpression

public void setRequiredExpression(java.lang.String value)
Description copied from interface: CustomAttribute
Sets the expression that determine if an attribute is required.

Specified by:
setRequiredExpression in interface CustomAttribute
Parameters:
value - the expression to determine if an attribute is required.

getRequiredExpression

public java.lang.String getRequiredExpression()
Description copied from interface: CustomAttribute
Returns the expression that determine if this attribute is required.

Specified by:
getRequiredExpression in interface CustomAttribute
Returns:
the expression to determine if this attribute is required.

setUpdateableExpression

public void setUpdateableExpression(java.lang.String value)
Description copied from interface: Attribute
Registers the expression that control if this attribute is updateable.

Specified by:
setUpdateableExpression in interface Attribute
Overrides:
setUpdateableExpression in class AttributeImpl
Parameters:
value - the expression to control if this attribute is updateable.

setDisplayWidth

public void setDisplayWidth(int value)
Description copied from interface: CustomAttribute
Sets the display width of this attribute.

Specified by:
setDisplayWidth in interface CustomAttribute
Parameters:
value - this display width

getDisplayWidth

public int getDisplayWidth()
Description copied from interface: CustomAttribute
Returns the display width of this attribute.

Specified by:
getDisplayWidth in interface CustomAttribute
Returns:
the display width. If display width is not set, -1 is returned

setDisplayHeight

public void setDisplayHeight(int value)
Description copied from interface: CustomAttribute
Sets the display height of this attribute.

Specified by:
setDisplayHeight in interface CustomAttribute
Parameters:
value - the display height

getDisplayHeight

public int getDisplayHeight()
Description copied from interface: CustomAttribute
Returns the display height of this attribute.

Specified by:
getDisplayHeight in interface CustomAttribute
Returns:
the display height. If display height is not set, -1 is returned

setUpdateable

public void setUpdateable(boolean value)
Description copied from interface: CustomAttribute
Sets if the attribute is updateable.

Specified by:
setUpdateable in interface CustomAttribute
Parameters:
value - if this attribute is updateable

isUpdateable

public boolean isUpdateable()
Description copied from interface: CustomAttribute
Returns if this attribute is updateable

Specified by:
isUpdateable in interface CustomAttribute
Returns:
if this attribute is updateable

setSearchable

public void setSearchable(boolean value)
Description copied from interface: CustomAttribute
Sets if this attribute is searchable.

Specified by:
setSearchable in interface CustomAttribute
Parameters:
value - if this attribute is searchable

isSearchable

public boolean isSearchable()
Description copied from interface: CustomAttribute
Returns if this attribute is searchable.

Specified by:
isSearchable in interface CustomAttribute
Returns:
if this attribute is searchable

setIndexed

public void setIndexed(boolean value)
Description copied from interface: CustomAttribute
Sets if this attribute is indexed.

Specified by:
setIndexed in interface CustomAttribute
Parameters:
value - if this attribute is indexed

isIndexed

public boolean isIndexed()
Description copied from interface: CustomAttribute
Returns if the attribute is indexed.

Specified by:
isIndexed in interface CustomAttribute
Returns:
if the attribute is indexed

setMinLength

public void setMinLength(int value)
Description copied from interface: CustomAttribute
Sets the minimum length of this attribute.

Specified by:
setMinLength in interface CustomAttribute
Parameters:
value - the minimum length

getMinLength

public int getMinLength()
Description copied from interface: CustomAttribute
Returns the minimum length of this attribute.

Specified by:
getMinLength in interface CustomAttribute
Returns:
the minimum length. If minimum length is not set, -1 is returned.

setMaxLength

public void setMaxLength(int value)
Description copied from interface: CustomAttribute
Sets the maximum length of this attribute.

Specified by:
setMaxLength in interface CustomAttribute
Parameters:
value - the maximum length

getMaxLength

public int getMaxLength()
Description copied from interface: CustomAttribute
Returns the maximum length of this attribute.

Specified by:
getMaxLength in interface CustomAttribute
Returns:
the maximum length. If maximum length is not set, null is returned.

setMinValue

public void setMinValue(java.math.BigDecimal value)
Description copied from interface: CustomAttribute
Sets the minimum value of this attribute.

Specified by:
setMinValue in interface CustomAttribute
Parameters:
value - the minimum value

getMinValue

public java.math.BigDecimal getMinValue()
Description copied from interface: CustomAttribute
Returns the minimum value of this attribute.

Specified by:
getMinValue in interface CustomAttribute
Returns:
the minimum value. If minimum value is not set, null is returned.

setMaxValue

public void setMaxValue(java.math.BigDecimal value)
Description copied from interface: CustomAttribute
Sets the maximum value of this attribute.

Specified by:
setMaxValue in interface CustomAttribute
Parameters:
value - the maximum value

getMaxValue

public java.math.BigDecimal getMaxValue()
Description copied from interface: CustomAttribute
Returns the maximum value of this attribute.

Specified by:
getMaxValue in interface CustomAttribute
Returns:
the maximum value. If maximum value is not set, -1 is returned.

setDecimalPlace

public void setDecimalPlace(int value)
Description copied from interface: CustomAttribute
Sets the decimal place of this attribute.

Specified by:
setDecimalPlace in interface CustomAttribute
Parameters:
value - the decimal place

getDecimalPlace

public int getDecimalPlace()
Description copied from interface: CustomAttribute
Returns the decimal place of this attribute

Specified by:
getDecimalPlace in interface CustomAttribute
Returns:
the decimal place. If decimal place is not set, -1 is returned.

setDefaultValue

public void setDefaultValue(java.lang.String value)
Description copied from interface: CustomAttribute
Sets the default value of this attribute.

Specified by:
setDefaultValue in interface CustomAttribute
Parameters:
value - the default value

getDefaultValue

public java.lang.String getDefaultValue()
Description copied from interface: CustomAttribute
Returns the default value of this attribute.

Specified by:
getDefaultValue in interface CustomAttribute
Returns:
the default value

setExpression

public void setExpression(java.lang.String value)
Description copied from interface: CustomAttribute
Sets the expression of this attribute.

Specified by:
setExpression in interface CustomAttribute
Parameters:
value - the expression

getExpression

public java.lang.String getExpression()
Description copied from interface: CustomAttribute
Returns the expression of this attribute.

Specified by:
getExpression in interface CustomAttribute
Returns:
the expression

isDefaultValueExpression

public boolean isDefaultValueExpression()
Description copied from interface: CustomAttribute
Returns if the default value of this attribute is an expression.

Specified by:
isDefaultValueExpression in interface CustomAttribute
Returns:
if the default value of this attribute is an expression

setDatetimeDisplayType

public void setDatetimeDisplayType(DatetimeDisplayType displayType)
Description copied from interface: CustomAttribute
Sets the display type of a Datetime attribute. Valid values are "Time", "Date", and "both".

Specified by:
setDatetimeDisplayType in interface CustomAttribute
Parameters:
displayType - the display type

getDatetimeDisplayType

public DatetimeDisplayType getDatetimeDisplayType()
Description copied from interface: CustomAttribute
Returns the display type of this attribute.

Specified by:
getDatetimeDisplayType in interface CustomAttribute
Returns:
the display type

setMultiselectFixedChoiceList

public void setMultiselectFixedChoiceList(boolean value)
Description copied from interface: CustomAttribute
Sets if the attribute is a multi-select fixed choice list.

Specified by:
setMultiselectFixedChoiceList in interface CustomAttribute
Parameters:
value - if the attribute is a multi-select fixed choice list

isMultiselectFixedChoiceList

public boolean isMultiselectFixedChoiceList()
Description copied from interface: CustomAttribute
Returns if this attribute is a multi-select fixed choice list.

Specified by:
isMultiselectFixedChoiceList in interface CustomAttribute
Returns:
if this attribute is a multi-select fixed choice list

setFixedChoiceListLookupType

public void setFixedChoiceListLookupType(java.lang.String value)
Description copied from interface: CustomAttribute
Sets the lookup type of the fixed choice list attribute.

Specified by:
setFixedChoiceListLookupType in interface CustomAttribute
Parameters:
value - the lookup type

getFixedChoiceListLookupType

public java.lang.String getFixedChoiceListLookupType()
Description copied from interface: CustomAttribute
Returns the lookup type of the fixed choice list attribute.

Specified by:
getFixedChoiceListLookupType in interface CustomAttribute
Specified by:
getFixedChoiceListLookupType in class AttributeImpl
Returns:
the lookup type of the fixed choice list attribute

setParentChoiceList

public void setParentChoiceList(Attribute parent,
                                java.util.Map<java.lang.String,java.util.List> valueMap)
Description copied from interface: CustomAttribute
Sets the parent choice list that constrains the values in this choice list.

Specified by:
setParentChoiceList in interface CustomAttribute
Parameters:
parent - the attribute of the parent choice list
valueMap - the value mapping between the parent choice list and this attribute

getParentChoiceList

public AttributeImpl getParentChoiceList()
Description copied from interface: CustomAttribute
Gets the parent the choice list that constrains the values in this choice list.

Specified by:
getParentChoiceList in interface CustomAttribute
Returns:
the attribute of the parent choice list

getFixedChoiceListValueMap

public java.util.Map<java.lang.String,java.util.List> getFixedChoiceListValueMap()
Description copied from interface: CustomAttribute
Gets the value map if this attribute is a cascading picklist.

Specified by:
getFixedChoiceListValueMap in interface CustomAttribute
Returns:
the value map between the parent choice list and this attribute

setListDisplayAttribute

public void setListDisplayAttribute(Attribute dataSourceAttribute)
Description copied from interface: CustomAttribute
Sets the list display attribute.

Specified by:
setListDisplayAttribute in interface CustomAttribute
Parameters:
dataSourceAttribute - the list display attribute

getListDisplayAttribute

public AttributeImpl getListDisplayAttribute()
Description copied from interface: CustomAttribute
Retursn the list display attribute.

Specified by:
getListDisplayAttribute in interface CustomAttribute
Returns:
the list display attribute

addDisplayAttribute

public void addDisplayAttribute(Attribute attr)
Description copied from interface: CustomAttribute
Adds an attribute to be included in the List of Values window for context.

Specified by:
addDisplayAttribute in interface CustomAttribute
Parameters:
attr - the attribute to be added

removeDisplayAttr

public void removeDisplayAttr(Attribute attr)
Description copied from interface: CustomAttribute
Removes an attribute from being included in the List of Values window for context.

Specified by:
removeDisplayAttr in interface CustomAttribute
Parameters:
attr - the attribute to be removed

getDisplayAttrs

public java.util.List<java.lang.String> getDisplayAttrs()
Description copied from interface: CustomAttribute
Returns list of display attributes that is included in the List of Values window for context.

Specified by:
getDisplayAttrs in interface CustomAttribute
Returns:
list of display attributes

addSearchAttribute

public void addSearchAttribute(Attribute attr)
Description copied from interface: CustomAttribute
Adds an attribute to be included as search criteria in addition to the selection display value

Specified by:
addSearchAttribute in interface CustomAttribute
Parameters:
attr - the attribute to be added

removeSearchAttr

public void removeSearchAttr(Attribute attr)
Description copied from interface: CustomAttribute
Removes an attribute from being included as search criteria in addition to the selection display value.

Specified by:
removeSearchAttr in interface CustomAttribute
Parameters:
attr - the attribute to be removed

getSearchAttrs

public java.util.List<java.lang.String> getSearchAttrs()
Description copied from interface: CustomAttribute
Return list of attributes that are included as search criteria in addition to the selection display value.

Specified by:
getSearchAttrs in interface CustomAttribute
Returns:
attributes list

setFormulaType

public void setFormulaType(FormulaType formulaType)
Description copied from interface: CustomAttribute
Sets the type of data the expression will be setting as this attribute value.

Specified by:
setFormulaType in interface CustomAttribute
Parameters:
formulaType - formula type

getFormulaType

public FormulaType getFormulaType()
Description copied from interface: CustomAttribute
Returns the type of data the expression will be setting as this attribute value.

Specified by:
getFormulaType in interface CustomAttribute
Returns:
formula type

setProperty

public void setProperty(java.lang.String property,
                        java.lang.Object value)
Specified by:
setProperty in interface CustomAttribute
Overrides:
setProperty in class BusinessEditorObjectImpl

isRemovable

public boolean isRemovable()
Description copied from interface: Attribute
Returns if this attribute is removable.

Specified by:
isRemovable in interface Attribute
Overrides:
isRemovable in class AttributeImpl
Returns:
if this attribute is removable

preCommit

protected void preCommit()
Overrides:
preCommit in class BusinessEditorBaseObjectImpl

postCommit

protected void postCommit()
Overrides:
postCommit in class BusinessEditorBaseObjectImpl

doRollback

protected void doRollback()
Overrides:
doRollback in class AttributeImpl

initFlowForNewObject

protected void initFlowForNewObject()
Specified by:
initFlowForNewObject in class BusinessEditorBaseObjectImpl

initFlowForExistingObject

protected void initFlowForExistingObject()
Specified by:
initFlowForExistingObject in class BusinessEditorBaseObjectImpl

finishFlowForNewObject

protected void finishFlowForNewObject()
Specified by:
finishFlowForNewObject in class BusinessEditorBaseObjectImpl

finishFlowForExistingObject

protected void finishFlowForExistingObject()
Specified by:
finishFlowForExistingObject in class BusinessEditorBaseObjectImpl

cancelFlowForNewObject

protected void cancelFlowForNewObject()
Specified by:
cancelFlowForNewObject in class BusinessEditorBaseObjectImpl

cancelFlowForExistingObject

protected void cancelFlowForExistingObject()
Specified by:
cancelFlowForExistingObject in class BusinessEditorBaseObjectImpl

getViewObjectBeingEdited

protected oracle.jbo.ViewObject getViewObjectBeingEdited()
Specified by:
getViewObjectBeingEdited in class BusinessEditorBaseObjectImpl

initialize

protected void initialize()
Overrides:
initialize in class BusinessEditorBaseObjectImpl

writeObject

protected void writeObject(oracle.jbo.Row object)
Overrides:
writeObject in class BusinessEditorBaseObjectImpl

isPropertyUpdateable

protected boolean isPropertyUpdateable(java.lang.String property)

setProperty

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

setProperty

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

getLogicalType

protected java.lang.String getLogicalType()
Specified by:
getLogicalType in class AttributeImpl

getObjectType

protected ObjectType getObjectType()
Specified by:
getObjectType in class BusinessEditorBaseObjectImpl

Oracle Fusion Middleware Java API Reference for Oracle ADF Model Business Editor Objects
11g Release 1 (11.1.1.7.0)

E36215-01

Copyright © 1997, 2013, Oracle. All rights reserved.