Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

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

java.lang.Object
  extended by oracle.apps.fnd.applcore.flex.runtime.util.common.LOVDefImpl
      extended by oracle.apps.fnd.applcore.flex.runtime.util.common.CustomLOVDefImpl
All Implemented Interfaces:
LOVDef

public class CustomLOVDefImpl
extends LOVDefImpl

An LOVDef implementation for CustomValueSetDef.


Nested Class Summary
static class CustomLOVDefImpl.ViewAttributeDef
          A view attribute definition.
 
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
 
Method Summary
static void buildActiveValuesCriteria(oracle.jbo.server.ViewDefImpl viewDef, java.lang.String criteriaName, java.lang.String startDateAttrName, java.lang.String endDateAttrName, java.lang.String vDateVarName)
          Builds the view criteria for active values.
static void buildEnabledValuesCriteria(oracle.jbo.server.ViewDefImpl viewDef, java.lang.String criteriaName, java.lang.String enabledFlagAttrName)
          Builds the criteria for enabled values.
static java.lang.String[] createCriteriaAndBindVariables(CustomValueSetDef vsd, oracle.jbo.server.ViewDefImpl viewDef)
          Creates the criteria and bind variables for a custom value set.
static java.util.List<CustomLOVDefImpl.ViewAttributeDef> createViewAttributes(CustomValueSetDef vsd, java.util.Map<java.lang.String,SegmentLabel.ValueAttribute> valAttrMap)
          Creates a list of view attributes for the custom LOV view object.
 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.
 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.
 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.
static java.lang.Class getJavaType(java.lang.String colType)
          Gets the Java type for a column type.
 java.lang.String getOrderBy()
          Gets the order-by statement.
 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.
 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
 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 oracle.apps.fnd.applcore.flex.runtime.util.common.LOVDefImpl
addSecurityCriteria, getAttributeName, getAttributeType, getDefObjectType, getEnabledFlagAttrName, getEndDateActiveAttrName, getStartDateActiveAttrName, getSummaryFlagAttrName, getValueSetUsage, getViewDefName, getViewObjValidationDateExpr, getViewObjValueSelectionClauseExpr
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createViewAttributes

public static java.util.List<CustomLOVDefImpl.ViewAttributeDef> createViewAttributes(CustomValueSetDef vsd,
                                                                                     java.util.Map<java.lang.String,SegmentLabel.ValueAttribute> valAttrMap)
Creates a list of view attributes for the custom LOV view object.

Parameters:
vsd - the custom value-set definition
valAttrMap - the value attribute definitions; the keys are the suggested view attribute names for these value attributes
Returns:
the list of view attributes

createCriteriaAndBindVariables

public static java.lang.String[] createCriteriaAndBindVariables(CustomValueSetDef vsd,
                                                                oracle.jbo.server.ViewDefImpl viewDef)
Creates the criteria and bind variables for a custom value set.

Parameters:
vsd - the custom value set definition
viewDef - the view definition where the criteria and bind variables should be created
Returns:
the key criteria name and the bound parameter name in an array in that order
Throws:
java.lang.IllegalArgumentException - if the given custom value set definition is null or the view definition is null, or if the given view definition does not have the attributes required for the view criteria

buildEnabledValuesCriteria

public static void buildEnabledValuesCriteria(oracle.jbo.server.ViewDefImpl viewDef,
                                              java.lang.String criteriaName,
                                              java.lang.String enabledFlagAttrName)
Builds the criteria for enabled values.

Parameters:
viewDef - the view definition where this criteria should be defined
criteriaName - the name of the criteria
enabledFlagAttrName - the name of the enabled flag attribute

buildActiveValuesCriteria

public static void buildActiveValuesCriteria(oracle.jbo.server.ViewDefImpl viewDef,
                                             java.lang.String criteriaName,
                                             java.lang.String startDateAttrName,
                                             java.lang.String endDateAttrName,
                                             java.lang.String vDateVarName)
Builds the view criteria for active values.

Parameters:
viewDef - the view object definition
criteriaName - the name of the criteria
startDateAttrName - the attribute name of the start date
endDateAttrName - the attribute name of the end date
vDateVarName - the name of the validation date bind variable

getJavaType

public static java.lang.Class getJavaType(java.lang.String colType)
Gets the Java type for a column type. The column types are defined in oracle.apps.fnd.applcore.flex.common.util.ColumnType.

Parameters:
colType - the column Type
Returns:

getViewDefName

public java.lang.String getViewDefName()
Gets the view definition that defines the LOV

Specified by:
getViewDefName in interface LOVDef
Overrides:
getViewDefName in class LOVDefImpl
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
Overrides:
getIdOrValueAttributeName in class LOVDefImpl
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
Overrides:
getIdOrValueCriteriaName in class LOVDefImpl
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
Overrides:
getIdOrValueVariableName in class LOVDefImpl
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
Overrides:
getDisplayAttributeName in class LOVDefImpl
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
Overrides:
getDisplayAttributeType in class LOVDefImpl
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
Overrides:
getHintAttributeNames in class LOVDefImpl
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
Overrides:
getOrderBy in class LOVDefImpl
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
Overrides:
getTableAliasForValueAttributes in class LOVDefImpl
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
Overrides:
getValueColumnForValidationRules in class LOVDefImpl
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
Overrides:
getViewCriteriaNames in class LOVDefImpl
Returns:
the names of the view criteria

getXViewCriteriaNames

public java.util.List<java.lang.String> getXViewCriteriaNames()
Description copied from class: LOVDefImpl
Gets the names of the view criteria for translation from values to displays.

Specified by:
getXViewCriteriaNames in interface LOVDef
Overrides:
getXViewCriteriaNames in class LOVDefImpl
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
Overrides:
getDisplayCriteriaName in class LOVDefImpl
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
Overrides:
getBoundParameterNames in class LOVDefImpl
Returns:
the names of the bound parameters; null if no bound parameters are required

getXBoundParameterNames

public java.util.List<java.lang.String> getXBoundParameterNames()
Description copied from class: LOVDefImpl
Gets the names of the bound parameters used for translation from values to displays.

Specified by:
getXBoundParameterNames in interface LOVDef
Overrides:
getXBoundParameterNames in class LOVDefImpl
Returns:
the names of the bound parameters used for translation; null if no translation is needed.

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
Overrides:
getBoundParameterValue in class LOVDefImpl
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

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

Copyright © 2012 Oracle. All Rights Reserved.