oracle.adfinternal.businesseditor.restapi

Class CustomAttributeImpl

java.lang.Object

oracle.adfinternal.businesseditor.restapi.AttributeImpl

oracle.adfinternal.businesseditor.restapi.CustomAttributeImpl

All Implemented Interfaces:

Attribute, CustomAttribute, VOAttributesConstants

public class CustomAttributeImpl
extends AttributeImpl
implements CustomAttribute

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseObject.ChildAlreadyExists
protected static interface	BaseObject.Manager
protected static class	BaseObject.Matcher
protected static class	BaseObject.STATE
protected static class	BaseObject.UnsupportedRestOperationException

Nested classes/interfaces inherited from class oracle.adfinternal.businesseditor.restapi.AttributeImpl

AttributeImpl.OtherFields

Nested classes/interfaces inherited from interface oracle.adf.businesseditor.objects.CustomAttribute

CustomAttribute.DynamicChoiceListDataFilterType

Field Summary

Fields inherited from interface oracle.adfinternal.businesseditor.restapi.VOAttributesConstants

ADDL_LIST_DISPLAY_FIELDS, ADDL_LIST_SEARCH_FIELDS, API_NAME, BODY, CHILD_LOOKUP_CODES, DATA_FILTERS, DATETIME_DISPLAY_TYPE, DECIMAL_PLACES, DEFAULT_VALUE, DEFINITION, DEPENDENCY_FIELDS, DESCRIPTION, DISPLAY_HEIGHT, DISPLAY_LABEL, DISPLAY_LABEL_PLURAL, DISPLAY_SEQUENCE, DISPLAY_WIDTH, ENABLED, END_DATE_ACTIVE, ERROR_MESSAGE, EXAMPLE, EXPRESSION, FIELDS, FORMULA_TYPE, FULL_NAME, FUNCTION_ID, FUNCTIONS, GLOBAL_FUNCTIONS, HELP_TEXT, ID, INDEXED, IS_CUSTOM, IS_MULTISELECT_PICKLIST, LIST_DISPLAY_FIELD, LIST_OBJECT, LOOKUP_CODE, LOOKUP_TYPE, LOOKUP_TYPES, LOOKUPS, MATCH_CASE, MAX_LENGTH, MAX_VALUE, MEANING, MIN_LENGTH, MIN_VALUE, NAME, OBJECTS, OPERATOR, PARAMETERS, PARENT_BUSINESS_OBJECT, PARENT_LOOKUP_CODE, PARENT_PICKLIST, PICKLIST_LOOKUP_TYPE, PRIVILEGE, PUBLISHED_AS_REST, RECORD_NAME_LABEL, REQUIRED, REQUIRED_EXPRESSION, RETURN_TYPE, SEARCH_FIELD_API_NAME, SETID, SORT_BY, SORT_BY_ASCENDING, START_DATE_ACTIVE, TRIGGERS, TYPE, UPDATABLE, UPDATABLE_EXPRESSION, VALIDATORS, VALUE_MAP, VALUE1, VALUE2, VISIBILITY_PROPERTY

Constructor Summary

Constructors

Constructor and Description
CustomAttributeImpl(BusinessObjectImpl owner, org.codehaus.jettison.json.JSONObject attr)

Method Summary

Modifier and Type	Method and Description
void	activate() Activate an attribute
oracle.adf.businesseditor.model.views.BindVarExprData	addBindVarExpr(java.lang.String varName, java.lang.String expression, java.lang.String varType) Applicable only for DCL attribute using expression criteria filter Adds a bind variable as advanced Data Filter parameter for a Dynamic Choice List.
DataFilter	addDataFilter(Attribute attr, ComparisonOperator operator, java.lang.Object[] values) Add a data filter to further refine the set of data appearing within the list of value used by dynamic choice list.
DataFilter	addDataFilter(Attribute attr, java.lang.String operator, java.lang.Object[] values) Add a data filter to further refine the set of data appearing within the list of value used by dynamic choice list.
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 org.codehaus.jettison.json.JSONObject	convertToJSON(java.lang.Object... attrNameAndValues)
protected <T> T	createChild(java.lang.String accessorName, java.lang.Class<T> type, org.codehaus.jettison.json.JSONObject obj)
protected void	deleteChild(BaseObject.Matcher matcher)
protected void	deleteChild(java.lang.String accessorName, java.lang.String childName)
void	deprecate() Deprecate an attribute
void	doCreateNewChildren()
void	doDeleteChildren()
void	doSetAttributes()
boolean	equals(java.lang.Object obj)
protected <T> T	findChild(java.lang.Class<T> type, BaseObject.Matcher matcher)
protected <T> T	findChild(java.lang.String accessorName, java.lang.String childName, java.lang.Class<T> type)
protected <T> java.util.List<T>	findChildren(java.lang.Class<T> type, BaseObject.Matcher matcher) Find all children objects matching the given Matcher.
java.lang.String	getApiName() Returns the API name of the custom attribte.
protected java.lang.Object	getAttribute(java.lang.String attrName)
protected java.lang.Object	getAttribute(java.lang.String attrName, java.lang.Object defaultValue) Get the attribute value for the given attribute name.
java.util.List<oracle.adf.businesseditor.model.views.BindVarExprData>	getBindVarExprList() Return list of bind variables that are used in Data Filter advanced mode expression to refine the set of data appearing within the list of value used by dynamic choice list (DCL).
protected <T> java.util.Collection<T>	getChildren(java.lang.String accessorName, java.lang.Class<T> type)
protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject>	getChildrenDeleted(BaseObject.Matcher childMatcher)
protected org.codehaus.jettison.json.JSONArray	getChildrenJSON(java.lang.String accessorName) Get all children of a given type defined by accessorName.
protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject>	getChildrenNew(BaseObject.Matcher childMatcher)
java.util.List<DataFilter>	getDataFilters() Return list of data filter that are used to refine the set of data appearing within the list of value used by dynamic choice list.
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.lang.String	getDescription()
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.
CustomAttribute.DynamicChoiceListDataFilterType	getDynamicChoiceListDataFilterType() Applicable only in expression criteria filter mode.
java.lang.String	getExistingCriteriaName() Applicable only in expression criteria filter mode.
java.lang.String	getExpression() Returns the expression of this attribute.
java.lang.String	getExpressionCriteriaFilter() Applicable only in expression criteria filter mode.
protected java.lang.String	getFinderKey(java.lang.String accessorName) Get the key whose value defines the resource name for this object in URL path
protected java.lang.String	getInternalName() Name that will represent the resource id for this object.
Attribute	getListDisplayAttribute() Retursn the list display attribute used by a dynamic choice list.
static java.lang.String	getLocalizedString(java.lang.String key, java.lang.Object... args)
protected oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger	getLogger()
BaseObject.Matcher	getMatcher() Get a Matcher that is used to compare with another object.
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	getName()
protected oracle.adfinternal.businesseditor.restapi.BaseObject	getOwner() Get the container object that contains this object.
protected java.lang.String[]	getQueryKeys(java.lang.String accessorName) Different types of objects use different names to find a child object.
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.
protected BaseObject.STATE	getState()
boolean	isCriteriaFilterIgnoreNullBindVarValues()
boolean	isDefaultValueExpression() Returns if the default value of this attribute is an expression.
boolean	isDeprecated() Return if an attribute is deprecated
boolean	isExpressionCriteriaFilter() Applicable only for lookup type attribute Returns true if Data Filter of a Dynamic Choice List uses an expression.
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	isNew()
void	removeDataFilter(DataFilter dataFilter) Remove the data filter that is used to refine the set of data appearing within the list of value used by dynamic choice list.
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.
protected void	setAttribute(java.lang.String attrName, java.lang.Object value)
void	setCriteriaFilterIgnoreNullBindVarValues(boolean ignoreNullBindVarValues) Applicable only in expression criteria filter mode.
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	setDescription(java.lang.String text)
void	setDisplayHeight(int value) Sets the display height of this attribute.
void	setDisplayWidth(int value) Sets the display width of this attribute.
void	setDynamicChoiceListDataFilterType(CustomAttribute.DynamicChoiceListDataFilterType type) Sets the type of data filter the dynamic choice list field will use.
void	setExistingCriteriaName(java.lang.String criteriaName) Sets the existing criteria name for the data filter the dynamic choice list field will use.
void	setExpression(java.lang.String value) Sets the expression of this attribute.
void	setExpressionCriteriaFilter(java.lang.String criteriaExpression) Applicable only in expression criteria filter mode.
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	setIsExpressionCriteriaFilter(boolean criteriaMode) Applicable only for lookup type attribute.
void	setListDisplayAttribute(Attribute dataSourceAttribute) Sets the list display attribute to be used by a dynamic choice list.
protected void	setLogger(oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger logger)
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.Throws JboException if minimum value cannot be set for the attribute type.
void	setMultiselectFixedChoiceList(boolean value) Sets if the attribute is a multi-select fixed choice list.
void	setName(java.lang.String name) Renames this object.
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	setUpdateable(boolean value) Sets if the attribute is updateable.
void	undoChanges()
protected void	verifyObjectIsValid() Verifies if object is valid.

Methods inherited from class oracle.adfinternal.businesseditor.restapi.AttributeImpl

addDependencyAttr, addOtherAttr, createTrigger, createTrigger, createValidator, deleteTrigger, deleteValidator, findTrigger, findValidator, getAccessorNameFromOwner, getBusinessObject, getCustomProperties, getCustomProperty, getDependencyAttributes, getDependencyAttrs, getDisplayLabel, getFixedChoiceListLookupType, getFixedChoiceListSetidEnabledValueMap, getFixedChoiceListValueMap, getFormulaType, getHelpText, getOtherAttributes, getOtherAttrs, getParentChoiceList, getTriggers, getType, getUpdateableExpression, getValidators, initChildObject, isRemovable, isRequired, isSearchable, isUpdateable, removeDependencyAttr, removeOtherAttr, setCustomProperty, setDisplayLabel, setHelpText, setParentChoiceList, setParentChoiceListWithSetIdLookup, setRequired, setSearchable, setUpdateableExpression, toApiName

Methods inherited from class java.lang.Object

clone, 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, getBusinessObject, getCustomProperties, getCustomProperty, getDependencyAttributes, getDependencyAttrs, getDescription, getDisplayLabel, getFixedChoiceListLookupType, getFixedChoiceListSetidEnabledValueMap, getFixedChoiceListValueMap, getFormulaType, getHelpText, getName, getParentChoiceList, getTriggers, getType, getUpdateableExpression, getValidators, isRemovable, isRequired, isSearchable, isUpdateable, removeDependencyAttr, setCustomProperty, setDescription, setDisplayLabel, setHelpText, setParentChoiceList, setParentChoiceListWithSetIdLookup, setRequired, setSearchable, setUpdateableExpression

Constructor Detail

CustomAttributeImpl

public CustomAttributeImpl(BusinessObjectImpl owner,
                           org.codehaus.jettison.json.JSONObject attr)
                    throws java.lang.Exception

Throws:

java.lang.Exception

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

Returns:

the API name

setRequiredExpression

public void setRequiredExpression(java.lang.String value)

Description copied from interface: Attribute

Sets the expression that determine if an attribute is required.

Specified by:

setRequiredExpression in interface Attribute

Specified by:

setRequiredExpression in interface CustomAttribute

Overrides:

setRequiredExpression in class AttributeImpl

Parameters:

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

getRequiredExpression

public java.lang.String getRequiredExpression()

Description copied from interface: Attribute

Returns the expression that determine if this attribute is required.

Specified by:

getRequiredExpression in interface Attribute

Specified by:

getRequiredExpression in interface CustomAttribute

Overrides:

getRequiredExpression in class AttributeImpl

Returns:

the expression to determine if this attribute is required.

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

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. Throws JboException if maximum length cannot be set for the attribute type.

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.Throws JboException if minimum value cannot be set for the attribute type.

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. To specify multiple default values for a picklist, provide the default values in a comma separated list.

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". Throws JboException if display type cannot be set for the attribute type.

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

setIncludedInServicePayload

public void setIncludedInServicePayload(boolean value)

Description copied from interface: CustomAttribute

Sets if this attribute is included in the service payload

Specified by:

setIncludedInServicePayload in interface CustomAttribute

Parameters:

value - if this attribute is included in the service payload

isIncludedInServicePayload

public boolean isIncludedInServicePayload()

Description copied from interface: CustomAttribute

Returns if this attribute is included in the service payload

Specified by:

isIncludedInServicePayload in interface CustomAttribute

Returns:

if this attribute is included in the service payload

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

setListDisplayAttribute

public void setListDisplayAttribute(Attribute dataSourceAttribute)

Description copied from interface: CustomAttribute

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

Specified by:

setListDisplayAttribute in interface CustomAttribute

Parameters:

dataSourceAttribute - the list display attribute

getListDisplayAttribute

public Attribute getListDisplayAttribute()

Description copied from interface: CustomAttribute

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

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 attribute names

getDisplayAttributes

public java.util.List<Attribute> getDisplayAttributes()

Description copied from interface: CustomAttribute

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

Specified by:

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

list of attribute names

getSearchAttributes

public java.util.List<Attribute> getSearchAttributes()

Description copied from interface: CustomAttribute

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

Specified by:

getSearchAttributes in interface CustomAttribute

Returns:

list of attributes

addDataFilter

public DataFilter addDataFilter(Attribute attr,
                                java.lang.String operator,
                                java.lang.Object[] values)

Description copied from interface: CustomAttribute

Add a data filter to further refine the set of data appearing within the list of value used by dynamic choice list. This can be called only if the attribute is a DCL that uses simple data filter, not expression.

Specified by:

addDataFilter in interface CustomAttribute

Parameters:

attr - Attribute of the search field. The attribute must belong to the same business object as the list display attribute

operator - Operator of the filter

values - Values of the filter

Returns:

new DataFilter

addDataFilter

public DataFilter addDataFilter(Attribute attr,
                                ComparisonOperator operator,
                                java.lang.Object[] values)

Description copied from interface: CustomAttribute

Add a data filter to further refine the set of data appearing within the list of value used by dynamic choice list. This can be called only if the attribute is a DCL that uses simple data filter, not expression.

Specified by:

addDataFilter in interface CustomAttribute

Parameters:

attr - Attribute of the search field. The attribute must belong to the same business object as the list display attribute

operator - Operator of the filter

values - Values of the filter

Returns:

new DataFilter

removeDataFilter

public void removeDataFilter(DataFilter dataFilter)

Description copied from interface: CustomAttribute

Remove the data filter that is used to refine the set of data appearing within the list of value used by dynamic choice list. This can be called only if the attribute is a DCL that uses simple data filter, not expression.

Specified by:

removeDataFilter in interface CustomAttribute

Parameters:

dataFilter - filter to remove

getDataFilters

public java.util.List<DataFilter> getDataFilters()

Description copied from interface: CustomAttribute

Return list of data filter that are used to refine the set of data appearing within the list of value used by dynamic choice list. This can be called only if the attribute is a DCL that uses simple data filter, not expression. If the DCL is in expression data filter mode, this will return null.

Specified by:

getDataFilters in interface CustomAttribute

Returns:

list of data filters

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

setProperty

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

Description copied from interface: CustomAttribute

Assign a value to a property for the attribute

Specified by:

setProperty in interface CustomAttribute

Parameters:

property - the name of the property to be updated

value - the value of the property

deprecate

public void deprecate()

Description copied from interface: CustomAttribute

Deprecate an attribute

Specified by:

deprecate in interface CustomAttribute

activate

public void activate()

Description copied from interface: CustomAttribute

Activate an attribute

Specified by:

activate in interface CustomAttribute

isDeprecated

public boolean isDeprecated()

Description copied from interface: CustomAttribute

Return if an attribute is deprecated

Specified by:

isDeprecated in interface CustomAttribute

Returns:

if an attribute is deprecated

getBindVarExprList

public java.util.List<oracle.adf.businesseditor.model.views.BindVarExprData> getBindVarExprList()

Description copied from interface: CustomAttribute

Return list of bind variables that are used in Data Filter advanced mode expression to refine the set of data appearing within the list of value used by dynamic choice list (DCL). A bind variable can be used only if the Data Filter view criteria uses an expression. Hence this can be called only in expression criteria filter mode. Changes made to any of the returned BindVarExprData will not dirty this DCL field and hence not guaranteed to be saved. Use CustomAttribute.addBindVarExpr(String, String, String) instead.

Specified by:

getBindVarExprList in interface CustomAttribute

Returns:

list of bind variables used in Dynamic Choice List Data Filter

isExpressionCriteriaFilter

public boolean isExpressionCriteriaFilter()

Description copied from interface: CustomAttribute

Applicable only for lookup type attribute Returns true if Data Filter of a Dynamic Choice List uses an expression. Internally, the list source creates a view criteria having a groovy expression instead of criteria row items.

Specified by:

isExpressionCriteriaFilter in interface CustomAttribute

Returns:

true if attribute type is Dynamic Choice List and Data Filter uses expression

setIsExpressionCriteriaFilter

public void setIsExpressionCriteriaFilter(boolean criteriaMode)

Description copied from interface: CustomAttribute

Applicable only for lookup type attribute. sets the dynamic choice list in advanced data filter mode that uses groovy expression data filter rather than criteria row items. If the new filter mode is different from the old mode, some of the related information about the choice list will be cleared off. For instance, if new mode is a simple data filter mode, data filters will be cleared off. If new mode is expression filter mode, bind variable and bound expression values will be cleared off and filter expression will be set to empty string.

Specified by:

setIsExpressionCriteriaFilter in interface CustomAttribute

Parameters:

criteriaMode - isfilter

getExpressionCriteriaFilter

public java.lang.String getExpressionCriteriaFilter()

Description copied from interface: CustomAttribute

Applicable only in expression criteria filter mode. Returns the expression used in the Data Filter of a Dynamic Choice List. If we are in simple data filter mode, this will return null.

Specified by:

getExpressionCriteriaFilter in interface CustomAttribute

Returns:

expression used in the Data Filter of a Dynamic Choice List

addBindVarExpr

public oracle.adf.businesseditor.model.views.BindVarExprData addBindVarExpr(java.lang.String varName,
                                                                            java.lang.String expression,
                                                                            java.lang.String varType)

Description copied from interface: CustomAttribute

Applicable only for DCL attribute using expression criteria filter Adds a bind variable as advanced Data Filter parameter for a Dynamic Choice List. If the variable does not exist in the list's target object, it will be added. It is expected that a need to call this method arises only if the variable is used in the data filter expression CustomAttribute.setExpressionCriteriaFilter(String) If the variable is not used in data filter expression, this call will be ignored during the time of saving. If editing this dynamic choice list field and if we only want to make changes to the variable's bound expression, still use this method by passing the same type as before. Adding same name as an existing one, but with different type will cause a JboException error. It does not matter if a variable's bound value expression is added first or data filter expression is set first. Actual bind variable creation and setting expression is done during saving. Type can be Number or Date or Text. Anything else will still be considered as Text.

Specified by:

addBindVarExpr in interface CustomAttribute

Parameters:

varName - variable name

expression - expression

varType - "Number" or "Date" or "Text". Default is "Text"

Returns:

expression data

See Also:

CustomAttribute.setExpressionCriteriaFilter(String)

setExpressionCriteriaFilter

public void setExpressionCriteriaFilter(java.lang.String criteriaExpression)

Description copied from interface: CustomAttribute

Applicable only in expression criteria filter mode. Sets the expression used in the advanced Data Filter of a Dynamic Choice List. For each bind variable used in this expression, a bound value expression should be provided using CustomAttribute.addBindVarExpr(String, String, String)

Specified by:

setExpressionCriteriaFilter in interface CustomAttribute

Parameters:

criteriaExpression - Advanced Data Filter expression using bind variables

setCriteriaFilterIgnoreNullBindVarValues

public void setCriteriaFilterIgnoreNullBindVarValues(boolean ignoreNullBindVarValues)

Description copied from interface: CustomAttribute

Applicable only in expression criteria filter mode.

Specified by:

setCriteriaFilterIgnoreNullBindVarValues in interface CustomAttribute

Parameters:

ignoreNullBindVarValues - Ignores bind variables whose values are null

isCriteriaFilterIgnoreNullBindVarValues

public boolean isCriteriaFilterIgnoreNullBindVarValues()

Specified by:

isCriteriaFilterIgnoreNullBindVarValues in interface CustomAttribute

setDynamicChoiceListDataFilterType

public void setDynamicChoiceListDataFilterType(CustomAttribute.DynamicChoiceListDataFilterType type)

Description copied from interface: CustomAttribute

Sets the type of data filter the dynamic choice list field will use.

Specified by:

setDynamicChoiceListDataFilterType in interface CustomAttribute

Parameters:

type - data filter type

getDynamicChoiceListDataFilterType

public CustomAttribute.DynamicChoiceListDataFilterType getDynamicChoiceListDataFilterType()

Description copied from interface: CustomAttribute

Applicable only in expression criteria filter mode. Returns the type of data filter the dynamic choice list field is using.

Specified by:

getDynamicChoiceListDataFilterType in interface CustomAttribute

Returns:

type of data filter the dynamic choice list field is using

setExistingCriteriaName

public void setExistingCriteriaName(java.lang.String criteriaName)

Description copied from interface: CustomAttribute

Sets the existing criteria name for the data filter the dynamic choice list field will use.

Specified by:

setExistingCriteriaName in interface CustomAttribute

Parameters:

criteriaName - name of existing view criteria

getExistingCriteriaName

public java.lang.String getExistingCriteriaName()

Description copied from interface: CustomAttribute

Applicable only in expression criteria filter mode. Returns the name of the existing view criteria used by the dynamic choice list data filter. If we are in simple data filter mode, this will return null.

Specified by:

getExistingCriteriaName in interface CustomAttribute

Returns:

existing view criteria name used in the Data Filter of a DCL

getOwner

protected oracle.adfinternal.businesseditor.restapi.BaseObject getOwner()

Get the container object that contains this object. This will be null for containers of root level objects such as BusinessEditorManager, LookupManager. It should not return null for all other objects as it is used to construct the ReST request URL path.

Returns:

object that contains this object

getQueryKeys

protected java.lang.String[] getQueryKeys(java.lang.String accessorName)

Different types of objects use different names to find a child object. For example, BusinessEditorManager.findBusinessObject(String name) may use either FullName or just simple Name attribute value of the BusinessObject in the search. LookupManager.findLookupType(String code) will use LookupType attribute as the code.

Parameters:

accessorName - the resource name to reach a particular type of child object

Returns:

attributes whose values are used for matching the parameter in findChild

getFinderKey

protected java.lang.String getFinderKey(java.lang.String accessorName)

Get the key whose value defines the resource name for this object in URL path

Parameters:

accessorName - the resource name to reach a particular type of child object

Returns:

attribute whose value will be used as the resource name of this object

getInternalName

protected final java.lang.String getInternalName()

Name that will represent the resource id for this object. This will be typically the value of the primary/finder key. The name is initialized during constructor of the object based on the JSON structure and the finder key value. This is not necessarily the name returned by getName() or the name that is used to identify the object in a findChild.

Returns:

resource name that represents this object in a ReST URL path

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

Renames this object. It throws BaseObject.ChildAlreadyExists if there is a name clash. Whether the name can be overloaded or not is left to the findChild(Class, Matcher)

Parameters:

name - new name

setDescription

public void setDescription(java.lang.String text)

getDescription

public java.lang.String getDescription()

getAttribute

protected java.lang.Object getAttribute(java.lang.String attrName)

verifyObjectIsValid

protected void verifyObjectIsValid()

Verifies if object is valid. An existing object can become invalid if it is deleted. A newly created object will become invalid if transaction is rolled back before commit.

Throws:

oracle.jbo.JboException - if object is invalid

getAttribute

protected java.lang.Object getAttribute(java.lang.String attrName,
                                        java.lang.Object defaultValue)

Get the attribute value for the given attribute name. Return defaultValue if the value is null.

Parameters:

attrName - name of attribute

defaultValue - default value

Returns:

attribute value of attribute attrName

getLogger

protected oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger getLogger()

setLogger

protected void setLogger(oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger logger)

getState

protected BaseObject.STATE getState()

isNew

public boolean isNew()

setAttribute

protected void setAttribute(java.lang.String attrName,
                            java.lang.Object value)

getMatcher

public BaseObject.Matcher getMatcher()

Get a Matcher that is used to compare with another object. This is different from equals(Object) which does a finer comparision of the whole URL path. For example, functions from global functions or different business objects might match in signature but not equal as their URL path will be different.

Returns:

gets a Matcher that would typically match this object

getChildrenDeleted

protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject> getChildrenDeleted(BaseObject.Matcher childMatcher)

getChildrenNew

protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject> getChildrenNew(BaseObject.Matcher childMatcher)

findChild

protected <T> T findChild(java.lang.String accessorName,
                          java.lang.String childName,
                          java.lang.Class<T> type)

findChild

protected <T> T findChild(java.lang.Class<T> type,
                          BaseObject.Matcher matcher)

findChildren

protected <T> java.util.List<T> findChildren(java.lang.Class<T> type,
                                             BaseObject.Matcher matcher)

Find all children objects matching the given Matcher. This function does not call getChildren() since getChildren() gets an entire list and thus the call can be heavy on network traffic unnecessarily.

Type Parameters:

T - Class that is expected type of the returned children objects.

Parameters:

type - Class instance of type T

matcher - Matcher that is used to find the correct children

Returns:

list of children of given type and matching the given Matcher

getChildrenJSON

protected org.codehaus.jettison.json.JSONArray getChildrenJSON(java.lang.String accessorName)
                                                        throws java.lang.Exception

Get all children of a given type defined by accessorName. The children are in JSON array structure.

Parameters:

accessorName - resource name or type of the children objects

Returns:

array of children in JSON structure

Throws:

java.lang.Exception - if any thrown by the GET request

getChildren

protected <T> java.util.Collection<T> getChildren(java.lang.String accessorName,
                                                  java.lang.Class<T> type)

createChild

protected <T> T createChild(java.lang.String accessorName,
                            java.lang.Class<T> type,
                            org.codehaus.jettison.json.JSONObject obj)

deleteChild

protected void deleteChild(java.lang.String accessorName,
                           java.lang.String childName)

deleteChild

protected void deleteChild(BaseObject.Matcher matcher)

convertToJSON

protected org.codehaus.jettison.json.JSONObject convertToJSON(java.lang.Object... attrNameAndValues)

doDeleteChildren

public void doDeleteChildren()

doCreateNewChildren

public void doCreateNewChildren()

doSetAttributes

public void doSetAttributes()

undoChanges

public void undoChanges()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getLocalizedString

public static java.lang.String getLocalizedString(java.lang.String key,
                                                  java.lang.Object... args)