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 DescriptiveFlexfieldDefManager

java.lang.Object
  extended by oracle.apps.fnd.applcore.flex.runtime.util.common.FlexfieldDefManager
      extended by oracle.apps.fnd.applcore.flex.runtime.util.common.DescriptiveFlexfieldDefManager
Direct Known Subclasses:
ExtensibleFlexfieldDefManager

public class DescriptiveFlexfieldDefManager
extends FlexfieldDefManager

A definition manager for descriptive flexfields.


Nested Class Summary
protected static class FlexfieldDefManagerImpl._ContextValueDef
          A simple implementation of ContextValueDef.
protected static class FlexfieldDefManagerImpl.SegmentDefArrayList
          A SegmentDefList implementation that uses an ArrayList as the storage.
 
Field Summary
protected  ApplicationResources _applicationResources
           
 
Method Summary
 java.lang.String getCustomFactoryClassName()
           
protected static SegmentDefImpl getDFFSegmentDefImpl(oracle.jbo.Row segRow, java.lang.String dbColPrefix, boolean isContextSeg, java.util.Map<java.lang.String,ValueSetDef> valueSetCache)
           
 FlexfieldDef getFlexfieldDef(FlexfieldTableUsage tableUsageRef, FlexfieldDefOverride ovr)
          Gets the definition of a table usage of a flexfield with information that overrides the original definition.
protected  FlexfieldDef getFlexfieldDefInternal(FlexfieldTableUsage tableUsageRef)
          Deprecated.  
protected  FlexfieldDef getFlexfieldDefInternal(FlexfieldTableUsage tableUsageRef, FlexfieldDefOverride ovr)
          Gets the definition of a table usage of a flexfield.
protected static oracle.apps.fnd.applcore.flex.runtime.util.common.FlexfieldDefManagerImpl getFlexfieldDefManagerImpl(java.lang.String type, ApplicationResources appRes)
          Gets an instance of a flexfield definition manager.
 FlexfieldEntityUsage getFlexfieldEntityUsage(FlexfieldTableUsage tableUsageRef, java.lang.String entityDefFullName)
          Gets a flexfield entity usage.
protected  FlexfieldEntityUsage getFlexfieldEntityUsageInternal(FlexfieldTableUsage tableUsageRef, java.lang.String entityDefFullName)
          Gets a flexfield entity usage.
protected static java.util.List<FlexfieldEntityUsage> getFlexfieldEntityUsages(FlexfieldTableUsage tableUsage, FlexfieldDefManager defManager, oracle.jbo.RowIterator entityUsageIterator, java.lang.String targetEntityDefName)
          Gets the list of entity usages.
protected static java.util.Map<java.lang.String,java.lang.String> getTranslations(oracle.jbo.Row viewRow, java.lang.String viewAttrName)
          Gets the translations of a column of a view attribute.
protected static Validator getValidator(SegmentDef seg, oracle.jbo.Row vsRow, java.util.Map<java.lang.String,ValueSetDef> valueSetCache, boolean valueSetRequired)
          Gets validation information.
 java.lang.String queryBcModelerFactoryName(ApplicationIdentifier aif, java.lang.String flexCode)
          Gets the name of the modeler factory for a flexfield.
 java.lang.String queryBcModelerFactoryName(java.lang.String appShortName, java.lang.String flexCode)
          Deprecated.  
protected static void resolveReferenceSegment(SegmentDefList segList)
          Resolves the references to the peer segments.
protected static void setDisplayType(SegmentDefImpl seg, oracle.jbo.Row segmentRow)
          Sets the display type based on the descriptive flexfield metadata hint.
protected static void setUIControlType(SegmentDefImpl seg)
          Sets the UI control type for a segment.
 
Methods inherited from class oracle.apps.fnd.applcore.flex.runtime.util.common.FlexfieldDefManager
getFactoryDiscoveryManager, getFlexfieldDef, getInstance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_applicationResources

protected final ApplicationResources _applicationResources
Method Detail

getFlexfieldEntityUsageInternal

protected FlexfieldEntityUsage getFlexfieldEntityUsageInternal(FlexfieldTableUsage tableUsageRef,
                                                               java.lang.String entityDefFullName)
Gets a flexfield entity usage.

Parameters:
tableUsageRef - the reference to the table usage
entityDefFullName - the full name of the entity definition
Returns:
the flexfield entity usage; null if not found

getFlexfieldDefInternal

protected FlexfieldDef getFlexfieldDefInternal(FlexfieldTableUsage tableUsageRef,
                                               FlexfieldDefOverride ovr)
Gets the definition of a table usage of a flexfield.

Parameters:
tableUsageRef - the reference to the table usage
ovr - the information that overrides the original definition; null if no overriding is needed
Returns:
the flexfield definition; null if not found

getDFFSegmentDefImpl

protected static SegmentDefImpl getDFFSegmentDefImpl(oracle.jbo.Row segRow,
                                                     java.lang.String dbColPrefix,
                                                     boolean isContextSeg,
                                                     java.util.Map<java.lang.String,ValueSetDef> valueSetCache)
                                              throws SegmentDefException
Throws:
SegmentDefException

getFlexfieldDef

public final FlexfieldDef getFlexfieldDef(FlexfieldTableUsage tableUsageRef,
                                          FlexfieldDefOverride ovr)
Description copied from class: FlexfieldDefManager
Gets the definition of a table usage of a flexfield with information that overrides the original definition.

Specified by:
getFlexfieldDef in class FlexfieldDefManager
Parameters:
tableUsageRef - the reference to the table usage
ovr - the information that overrides the original definition; null if no overriding should occur
Returns:
the flexfield definition; null if not found

getFlexfieldEntityUsage

public FlexfieldEntityUsage getFlexfieldEntityUsage(FlexfieldTableUsage tableUsageRef,
                                                    java.lang.String entityDefFullName)
Description copied from class: FlexfieldDefManager
Gets a flexfield entity usage.

Specified by:
getFlexfieldEntityUsage in class FlexfieldDefManager
Parameters:
tableUsageRef - the reference to the table usage
entityDefFullName - the full name of the entity definition
Returns:
the flexfield entity usage; null if not found

getFlexfieldDefInternal

protected final FlexfieldDef getFlexfieldDefInternal(FlexfieldTableUsage tableUsageRef)
Deprecated. 

Parameters:
tableUsageRef -
Returns:

getFlexfieldDefManagerImpl

protected static oracle.apps.fnd.applcore.flex.runtime.util.common.FlexfieldDefManagerImpl getFlexfieldDefManagerImpl(java.lang.String type,
                                                                                                                      ApplicationResources appRes)
Gets an instance of a flexfield definition manager.

Parameters:
type - the flexfield type
appRes - the application resources
Returns:
a new instance of a Flexfield Definition Manager, taking into account the flexfield type.

getFlexfieldEntityUsages

protected static final java.util.List<FlexfieldEntityUsage> getFlexfieldEntityUsages(FlexfieldTableUsage tableUsage,
                                                                                     FlexfieldDefManager defManager,
                                                                                     oracle.jbo.RowIterator entityUsageIterator,
                                                                                     java.lang.String targetEntityDefName)
Gets the list of entity usages.

Parameters:
tableUsage - the table usage that contains the entity usages
defManager - the definition manager that calls this method
entityUsageIterator - the iterator of the entity usage list
targetEntityDefName - the entity definitio name of the usage to be found; null if all usages should be returned
Returns:
the list of entity usages; empty list if no usage is found

getTranslations

protected static java.util.Map<java.lang.String,java.lang.String> getTranslations(oracle.jbo.Row viewRow,
                                                                                  java.lang.String viewAttrName)
Gets the translations of a column of a view attribute. The view attribute must be associated with an entity and the entity must have a row iterator named OA_TL_ENTITIES. It is assumed that the corresponding entity attribute name is the same as the given view attribute name. The translation entity must have an attribute named "Language" that provides the language code.

Parameters:
viewRow - the view row
viewAttrName - the view attribute name
Returns:
the translations. The keys are language codes and the values are translations. An empty map is returned if no translations are found.

setDisplayType

protected static void setDisplayType(SegmentDefImpl seg,
                                     oracle.jbo.Row segmentRow)
                              throws SegmentDefException
Sets the display type based on the descriptive flexfield metadata hint.

Parameters:
seg - the segment
segmentRow - the row that represents the segment metadata
Throws:
SegmentDefException
See Also:
setUIControlType(oracle.apps.fnd.applcore.flex.runtime.util.common.SegmentDefImpl)

setUIControlType

protected static void setUIControlType(SegmentDefImpl seg)
Sets the UI control type for a segment. The control type is set based on the segment display type and the value type. If the control type of the segment is not null prior to calling this method, it will not be changed.

This method may adjust the segment definition such as the default value based on the control type. To avoid the adjustment being overwritten, this method should be invoked after the segment definition is loaded completely.

Parameters:
seg - the segment
See Also:
setDisplayType(oracle.apps.fnd.applcore.flex.runtime.util.common.SegmentDefImpl, oracle.jbo.Row)

getValidator

protected static Validator getValidator(SegmentDef seg,
                                        oracle.jbo.Row vsRow,
                                        java.util.Map<java.lang.String,ValueSetDef> valueSetCache,
                                        boolean valueSetRequired)
                                 throws SegmentDefException
Gets validation information.

Parameters:
seg - the segment
vsRow - the value set row
valueSetCache - the value set cache
valueSetRequired - true if this segment must use a value set
Returns:
the validator that represents the value set
Throws:
SegmentDefException - if any error occurs

resolveReferenceSegment

protected static void resolveReferenceSegment(SegmentDefList segList)
                                       throws SegmentDefException
Resolves the references to the peer segments. This method must be called to resolve any references to the peer segments in the value set usages.

Parameters:
segList - the segment list
Throws:
SegmentDefException - if any error occurs

getCustomFactoryClassName

public java.lang.String getCustomFactoryClassName()

queryBcModelerFactoryName

public java.lang.String queryBcModelerFactoryName(java.lang.String appShortName,
                                                  java.lang.String flexCode)
Deprecated. 

Gets the name of the modeler factory for a flexfield.

Parameters:
appShortName - the application short name
flexCode - the flexfield code
Returns:
the name of the modeler factory; null if no custom factory is registered
See Also:
queryBcModelerFactoryName(ApplicationIdentifier, String)

queryBcModelerFactoryName

public java.lang.String queryBcModelerFactoryName(ApplicationIdentifier aif,
                                                  java.lang.String flexCode)
Gets the name of the modeler factory for a flexfield.

Parameters:
aif - the application information
flexCode - the flexfield code
Returns:
the name of the modeler factory; null if no custom factory is registered

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

E22562-03

Copyright © 2012 Oracle. All Rights Reserved.