oracle.apps.fnd.applcore.flex.runtime.util.common
Class LOVDefImpl

java.lang.Object
  oracle.apps.fnd.applcore.flex.runtime.util.common.LOVDefImpl

All Implemented Interfaces:

LOVDef

Direct Known Subclasses:

CustomLOVDefImpl, SecuredLOVDefImpl

public class LOVDefImpl
extends java.lang.Object
implements LOVDef

A generic implementation of LOVDef.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.fnd.applcore.flex.runtime.util.common.LOVDef

LOVDef.DefObjectType, LOVDef.ParameterBoundValue, LOVDef.PropertyBoundValue, LOVDef.SegmentBoundValue

Field Summary

Fields inherited from interface oracle.apps.fnd.applcore.flex.runtime.util.common.LOVDef

PARAMETER_BOUND_VALUE, PROPERTY_BOUND_VALUE, SEGMENT_BOUND_VALUE

Constructor Summary

protected

LOVDefImpl(ValueSetUsage vsu, java.lang.String attrName, java.lang.Class attrType, LOVDef.DefObjectType objType) Constructs an LOVDefImpl from a value-set usage and the Java type of the attribute with which the LOV is associated.

Method Summary

protected static void	addSecurityCriteria(oracle.jbo.server.ViewDefImpl viewDef, java.lang.String criteriaName) Adds security criteria.
protected java.lang.String	getAttributeName() Gets the name of the attribute which this LOV is associated with.
protected java.lang.Class	getAttributeType() Gets the type of the attribute which this LOV is associated with.
java.util.List<java.lang.String>	getBoundParameterNames() Gets the names of the bound parameters.
PortableExpression	getBoundParameterValue(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> tokens) Gets the value of a bound parameter.
protected LOVDef.DefObjectType	getDefObjectType() Gets the type of the object where this LOV is used.
java.lang.String	getDisplayAttributeName() Gets the name of the view attribute that represents the display of a value.
java.lang.Class	getDisplayAttributeType() Gets the type of the display attribute.
java.lang.String	getDisplayCriteriaName() Gets the name of the display criteria.
static java.lang.String	getEnabledFlagAttrName() Gets the attribute name of ENABLED_FLAG column.
static java.lang.String	getEndDateActiveAttrName() Gets the attribute name of END_DATE_ACTIVE column.
java.util.List<java.lang.String>	getHintAttributeNames() Gets the list of view attributes that serve as hints when searching for a value.
java.lang.String	getIdOrValueAttributeName() Gets the name of the view attribute that represents the ID or value.
java.lang.String	getIdOrValueCriteriaName() Gets the name of the view criteria for locating an ID or a value.
java.lang.String	getIdOrValueVariableName() Gets the name of the bind variable for locating an ID or a value.
java.lang.String	getOrderBy() Gets the order-by statement.
static java.lang.String	getStartDateActiveAttrName() Gets the attribute name of START_DATE_ACTIVE column.
static java.lang.String	getSummaryFlagAttrName() Gets the attribute name of SUMMARY_FLAG column.
java.lang.String	getTableAliasForValueAttributes() Gets the table alias for value attributes.
java.lang.String	getValueColumnForValidationRules() Gets the value column (prefixed with alias if needed) used in validation rules.
protected ValueSetUsage	getValueSetUsage() Gets the value-set usage.
java.util.List<java.lang.String>	getViewCriteriaNames() Gets the names of the view criteria that must be applied.
java.lang.String	getViewDefName() Gets the view definition that defines the LOV
protected static java.lang.String	getViewDefName(ValueSetDef vsd) Gets the name of the list data source view object definition.
protected PortableExpression	getViewObjValidationDateExpr() Gets the expression for getting the validation date in a view accessor defined in a view object.
protected PortableExpression	getViewObjValueSelectionClauseExpr(java.lang.String viewAttrName) Gets the expression for extra validation rules.
java.util.List<java.lang.String>	getXBoundParameterNames() Gets the names of the bound parameters used for translation from values to displays.
java.util.List<java.lang.String>	getXViewCriteriaNames() Gets the names of the view criteria for translation from values to displays.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LOVDefImpl

protected LOVDefImpl(ValueSetUsage vsu,
                     java.lang.String attrName,
                     java.lang.Class attrType,
                     LOVDef.DefObjectType objType)

Constructs an LOVDefImpl from a value-set usage and the Java type of the attribute with which the LOV is associated.

Do not use this class with a CustomValueSetUsage object. Use CustomLOVDefImpl instead.

Parameters:

vsu - the value-set usage

attrName - the name of the attribute

attrType - the Java type of the attribute

objType - the type of the object where the LOV is used

Method Detail

getAttributeName

protected java.lang.String getAttributeName()

Gets the name of the attribute which this LOV is associated with.

Returns:

the name of the attribute

getAttributeType

protected java.lang.Class getAttributeType()

Gets the type of the attribute which this LOV is associated with.

Returns:

the type of the attribute

getDefObjectType

protected LOVDef.DefObjectType getDefObjectType()

Gets the type of the object where this LOV is used.

Returns:

the type of the object where this LOV is used

getValueSetUsage

protected ValueSetUsage getValueSetUsage()

Gets the value-set usage.

Returns:

the value-set usage

addSecurityCriteria

protected static void addSecurityCriteria(oracle.jbo.server.ViewDefImpl viewDef,
                                          java.lang.String criteriaName)

Adds security criteria.

Parameters:

viewDef - the view definition

criteriaName - the name of the security criteria

getViewDefName

protected static java.lang.String getViewDefName(ValueSetDef vsd)

Gets the name of the list data source view object definition.

Parameters:

vsd - the value-set definition

Returns:

the name of the list data source definition; null if the name cannot be determined

getViewDefName

public java.lang.String getViewDefName()

Gets the view definition that defines the LOV

Specified by:

getViewDefName in interface LOVDef

Returns:

the view definition

getIdOrValueAttributeName

public java.lang.String getIdOrValueAttributeName()

Gets the name of the view attribute that represents the ID or value.

Specified by:

getIdOrValueAttributeName in interface LOVDef

Returns:

the name of the view attribute that represents the ID or value

getIdOrValueCriteriaName

public java.lang.String getIdOrValueCriteriaName()

Description copied from interface: LOVDef

Gets the name of the view criteria for locating an ID or a value.

Specified by:

getIdOrValueCriteriaName in interface LOVDef

Returns:

the name of the view criteria for locating an ID or a value

getIdOrValueVariableName

public java.lang.String getIdOrValueVariableName()

Description copied from interface: LOVDef

Gets the name of the bind variable for locating an ID or a value.

Specified by:

getIdOrValueVariableName in interface LOVDef

Returns:

the name of the bind variable for locating an ID or a value

getDisplayAttributeName

public java.lang.String getDisplayAttributeName()

Gets the name of the view attribute that represents the display of a value.

Specified by:

getDisplayAttributeName in interface LOVDef

Returns:

the name of the view attribute that represents the display of a value

getDisplayAttributeType

public java.lang.Class getDisplayAttributeType()

Gets the type of the display attribute.

Specified by:

getDisplayAttributeType in interface LOVDef

Returns:

the type of the display attribute

See Also:

LOVDef.getDisplayAttributeName()

getHintAttributeNames

public java.util.List<java.lang.String> getHintAttributeNames()

Gets the list of view attributes that serve as hints when searching for a value. The value and display attribute are NOT included.

Specified by:

getHintAttributeNames in interface LOVDef

Returns:

the list of view attributes that serve as hints when searching for a value

getOrderBy

public java.lang.String getOrderBy()

Gets the order-by statement.

Specified by:

getOrderBy in interface LOVDef

Returns:

the order-by statement

getTableAliasForValueAttributes

public java.lang.String getTableAliasForValueAttributes()

Description copied from interface: LOVDef

Gets the table alias for value attributes.

Specified by:

getTableAliasForValueAttributes in interface LOVDef

Returns:

the table alias for value attributes; null if no alias is needed

getValueColumnForValidationRules

public java.lang.String getValueColumnForValidationRules()

Description copied from interface: LOVDef

Gets the value column (prefixed with alias if needed) used in validation rules. This is to replace &{VALUE.VALUE} in a rule.

Specified by:

getValueColumnForValidationRules in interface LOVDef

Returns:

the value column used in validation rules

getViewCriteriaNames

public java.util.List<java.lang.String> getViewCriteriaNames()

Gets the names of the view criteria that must be applied.

Specified by:

getViewCriteriaNames in interface LOVDef

Returns:

the names of the view criteria

getXViewCriteriaNames

public java.util.List<java.lang.String> getXViewCriteriaNames()

Gets the names of the view criteria for translation from values to displays.

Specified by:

getXViewCriteriaNames in interface LOVDef

Returns:

the names of the view criteria for translation; null if no translation is needed.

getDisplayCriteriaName

public java.lang.String getDisplayCriteriaName()

Gets the name of the display criteria.

Specified by:

getDisplayCriteriaName in interface LOVDef

Returns:

the name of the display criteria

getBoundParameterNames

public java.util.List<java.lang.String> getBoundParameterNames()

Gets the names of the bound parameters.

Specified by:

getBoundParameterNames in interface LOVDef

Returns:

the names of the bound parameters; null if no bound parameters are required

getXBoundParameterNames

public java.util.List<java.lang.String> getXBoundParameterNames()

Gets the names of the bound parameters used for translation from values to displays.

Specified by:

getXBoundParameterNames in interface LOVDef

Returns:

the names of the bound parameters used for translation; null if no translation is needed.

getViewObjValidationDateExpr

protected final PortableExpression getViewObjValidationDateExpr()

Gets the expression for getting the validation date in a view accessor defined in a view object.

Returns:

the expression for validation date

getViewObjValueSelectionClauseExpr

protected final PortableExpression getViewObjValueSelectionClauseExpr(java.lang.String viewAttrName)

Gets the expression for extra validation rules.

Parameters:

viewAttrName - the view attribute

Returns:

the expression for extra validation rules

getBoundParameterValue

public PortableExpression getBoundParameterValue(java.lang.String name,
                                                 java.util.Map<java.lang.String,java.lang.Object> tokens)

Gets the value of a bound parameter.

Specified by:

getBoundParameterValue in interface LOVDef

Parameters:

name - the name of the bound parameter

tokens - the tokens used to construct the parameter value

Returns:

the value of the bound parameter; null if the given bound parameter is not found or the value is not defined

getStartDateActiveAttrName

public static java.lang.String getStartDateActiveAttrName()

Gets the attribute name of START_DATE_ACTIVE column.

Returns:

the attribute name of START_DATE_ACTIVE column

getEndDateActiveAttrName

public static java.lang.String getEndDateActiveAttrName()

Gets the attribute name of END_DATE_ACTIVE column.

Returns:

the attribute name of END_DATE_ACTIVE column

getEnabledFlagAttrName

public static java.lang.String getEnabledFlagAttrName()

Gets the attribute name of ENABLED_FLAG column.

Returns:

the attribute name of ENABLED_FLAG column

getSummaryFlagAttrName

public static java.lang.String getSummaryFlagAttrName()

Gets the attribute name of SUMMARY_FLAG column.

Returns:

the attribute name of SUMMARY_FLAG column