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

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

All Implemented Interfaces:

FlexfieldDef

Direct Known Subclasses:

ExtensibleFlexfieldDefImpl

public class DescriptiveFlexfieldDefImpl
extends java.lang.Object

Definition of a descriptive flexfield.

Nested Class Summary

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

FlexfieldDef.MetadataType, FlexfieldDef.Parameter

Constructor Summary

protected

DescriptiveFlexfieldDefImpl(java.lang.Long appID, java.lang.String appShortName, java.lang.String name) Constructs a descriptive flexfield definition implementation.

Method Summary

protected void	addSegmentDefList(java.lang.Object discrValue, SegmentDefList list) Adds the segment definition list for a discriminator value.
java.lang.Long	getApplicationID() Gets the application ID with which this flexfield is associated.
java.lang.String	getApplicationModuleName() Gets the name of the application module associated with this flexfield.
java.lang.String	getApplicationName() Gets the full name of the application where this flexfield is defined.
java.lang.String	getApplicationShortName() Gets the short name of the application where this flexfield is defined.
java.lang.String	getBaseLanguage() Gets the base language.
java.lang.String	getBITreeDataViewDefName() Gets the full name of the BI tree data view definition.
java.lang.String	getDelimiter() Gets the default delimiter.
ContextValueDef[]	getDiscriminatorSegmentValues() Gets the list of values of a discriminator segment.
java.lang.String	getDisplayName() Gets the display name of the flexfield.
FlexfieldEntityUsage	getEntityUsage(java.lang.String entityDefFullName) Gets a flexfield entity usage.
java.util.List<java.lang.String>	getInstalledLanguages() Gets the list of installed languages.
java.lang.String	getName() Gets the name of this flexfield.
java.util.Map<java.lang.String,FlexfieldDef.Parameter>	getParameterMap() Gets a map of the flexfield parameters.
SegmentDefList	getSegmentDefs(java.lang.Object discrValue) Gets the list of segments for a discriminator value.
SegmentLabel	getSegmentLabel(java.lang.String labelCode) Gets a segment label associated with this flexfield.
java.util.Map<java.lang.String,SegmentLabel>	getSegmentLabelMap() Gets a map that contains all labels defined for this flexfield.
java.lang.String	getTableName() Gets the name of the database object where the flexfield is used.
java.util.Map<java.lang.String,java.lang.String>	getTranslatedDisplayNames() Gets the translations of the display names.
java.lang.String	getTreeStructureCode() Gets the code of the tree structure associated with this flexfield.
java.lang.String	getType() Gets the type of this flexfield.
java.lang.String	getUsageName() Gets the name of the flexfield usage.
java.lang.String	getUsageType() Gets the type of the usage.
boolean	isBIEnabled() Returns true if this flexfield is BI-enabled.
boolean	isMonomorphic() Returns true if this flexfield does not have a discriminator.
protected void	removeSegmentDefList(java.lang.Object discrValue) Removes the segment definition list associated with a discriminator value.
protected void	setApplicationID(java.lang.Long id) Sets the application ID that corresponds to the application short name.
protected void	setApplicationModuleName(java.lang.String name) Sets the name of the application module associated with this flexfield.
protected void	setApplicationName(java.lang.String name) Sets the application name.
protected void	setBaseLanguage(java.lang.String lang) Sets the base language for this flexfield.
protected void	setBIEnabled(boolean b) Sets whether this flexfield is BI-enabled.
protected void	setBITreeDataViewDefName(java.lang.String name) Sets the full name of the BI tree data view definition.
protected void	setDelimiter(java.lang.String d) Sets the delimiter of the flexfield.
protected void	setDiscriminatorSegmentValues(ContextValueDef[] values) Sets the discriminator segment values.
protected void	setDisplayName(java.lang.String s) Sets the display name.
protected void	setEntityUsage(java.lang.String entityDefFullName, FlexfieldEntityUsage feu) Sets a flexfield entity usage.
protected void	setInstalledLanguages(java.util.List<java.lang.String> langs) Sets the list of installed languages.
protected void	setMonomorphic(boolean b) Sets whether this flexfield is monomorphic.
protected void	setParameter(java.lang.String code, java.lang.Class javaType) Sets a parameter.
protected void	setSegmentLabelMap(java.util.Map<java.lang.String,SegmentLabel> map) Sets the label map.
void	setTableName(java.lang.String tableName) Sets the database object name.
protected void	setTranslatedDisplayNames(java.util.Map<java.lang.String,java.lang.String> map) Sets the translations of the display name.
protected void	setTreeStructureCode(java.lang.String code) Sets the tree structure code.
protected void	setUsageName(java.lang.String usageName) Sets the usage name.
protected void	setUsageType(java.lang.String type) Sets the type of the usage.

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptiveFlexfieldDefImpl

protected DescriptiveFlexfieldDefImpl(java.lang.Long appID,
                                      java.lang.String appShortName,
                                      java.lang.String name)

Constructs a descriptive flexfield definition implementation.

Parameters:

appID - the application ID

appShortName - the application short name

name - the name of the descriptive flexfield

Method Detail

getType

public java.lang.String getType()

Gets the type of this flexfield.

Specified by:

getType in interface FlexfieldDef

Returns:

the type of this flexfield

getApplicationShortName

public java.lang.String getApplicationShortName()

Gets the short name of the application where this flexfield is defined.

Specified by:

getApplicationShortName in interface FlexfieldDef

Returns:

the application short name

setApplicationID

protected void setApplicationID(java.lang.Long id)

Sets the application ID that corresponds to the application short name.

Parameters:

id - the application ID

getApplicationID

public java.lang.Long getApplicationID()

Gets the application ID with which this flexfield is associated.

Specified by:

getApplicationID in interface FlexfieldDef

Returns:

the application ID; null if the application ID has not resolved from the application short name

getName

public java.lang.String getName()

Gets the name of this flexfield. This is the "flexfield code" as defined in the metadata.

Specified by:

getName in interface FlexfieldDef

Returns:

the name of this flexfield

getDisplayName

public java.lang.String getDisplayName()

Gets the display name of the flexfield. This is the "flexfield name" as defined in the metadata.

Specified by:

getDisplayName in interface FlexfieldDef

Returns:

the display name of this flexfield

setDisplayName

protected void setDisplayName(java.lang.String s)

Sets the display name.

Parameters:

s - the display name

getTranslatedDisplayNames

public java.util.Map<java.lang.String,java.lang.String> getTranslatedDisplayNames()

Description copied from interface: FlexfieldDef

Gets the translations of the display names.

Specified by:

getTranslatedDisplayNames in interface FlexfieldDef

Returns:

the translations. The keys of the map are the language codes.

See Also:

FlexfieldDef.getDisplayName()

setTranslatedDisplayNames

protected void setTranslatedDisplayNames(java.util.Map<java.lang.String,java.lang.String> map)

Sets the translations of the display name.

Parameters:

map - the translations

setApplicationModuleName

protected void setApplicationModuleName(java.lang.String name)

Sets the name of the application module associated with this flexfield.

Parameters:

name - the name of the application module

getApplicationModuleName

public java.lang.String getApplicationModuleName()

Gets the name of the application module associated with this flexfield.

Specified by:

getApplicationModuleName in interface FlexfieldDef

Returns:

the name of the application module associated with this flexfield; null if no application module is assocaited

getApplicationName

public java.lang.String getApplicationName()

Gets the full name of the application where this flexfield is defined.

Specified by:

getApplicationName in interface FlexfieldDef

Returns:

the full name of the application

setApplicationName

protected void setApplicationName(java.lang.String name)

Sets the application name.

Parameters:

name - the applicatio name

getBaseLanguage

public java.lang.String getBaseLanguage()

Description copied from interface: FlexfieldDef

Gets the base language.

Specified by:

getBaseLanguage in interface FlexfieldDef

Returns:

the base language code; null if not defined

setBaseLanguage

protected void setBaseLanguage(java.lang.String lang)

Sets the base language for this flexfield.

Parameters:

lang - the base language

getInstalledLanguages

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

Description copied from interface: FlexfieldDef

Gets the list of installed languages.

Specified by:

getInstalledLanguages in interface FlexfieldDef

Returns:

the list of installed languages

setInstalledLanguages

protected void setInstalledLanguages(java.util.List<java.lang.String> langs)

Sets the list of installed languages.

Parameters:

langs - the list of installed languages

getUsageName

public java.lang.String getUsageName()

Gets the name of the flexfield usage.

Specified by:

getUsageName in interface FlexfieldDef

Returns:

the name of the flexfield usage

setUsageName

protected void setUsageName(java.lang.String usageName)

Sets the usage name.

Parameters:

usageName - the usage name

getUsageType

public java.lang.String getUsageType()

Gets the type of the usage.

Specified by:

getUsageType in interface FlexfieldDef

Returns:

the type of the usage

setUsageType

protected void setUsageType(java.lang.String type)

Sets the type of the usage.

Parameters:

type - the usage type

getTableName

public java.lang.String getTableName()

Gets the name of the database object where the flexfield is used.

Specified by:

getTableName in interface FlexfieldDef

Returns:

the name of the database object

setTableName

public void setTableName(java.lang.String tableName)

Sets the database object name.

Parameters:

tableName - the database object name

getDiscriminatorSegmentValues

public ContextValueDef[] getDiscriminatorSegmentValues()

Gets the list of values of a discriminator segment. If this method returns null, no values have been defined for the discriminator segment.

Specified by:

getDiscriminatorSegmentValues in interface FlexfieldDef

Returns:

the list of values of a discriminator segment

setDiscriminatorSegmentValues

protected void setDiscriminatorSegmentValues(ContextValueDef[] values)

Sets the discriminator segment values.

Parameters:

values - the discriminator segment values

getSegmentDefs

public SegmentDefList getSegmentDefs(java.lang.Object discrValue)

Gets the list of segments for a discriminator value. If the discriminator value is null, the global segments are returned. Please note that this method returns the complete list of segments including the global segments. To check if a segment is global or discriminator-value specific, check the segment.

Specified by:

getSegmentDefs in interface FlexfieldDef

Parameters:

discrValue - the discriminator value; null to get global segments

Returns:

the list of segments for the given discriminator value; null if a segment list has not been defined for the given discriminator value

addSegmentDefList

protected void addSegmentDefList(java.lang.Object discrValue,
                                 SegmentDefList list)

Adds the segment definition list for a discriminator value.

Parameters:

discrValue - the discriminator value

list - the segment definition list

removeSegmentDefList

protected void removeSegmentDefList(java.lang.Object discrValue)

Removes the segment definition list associated with a discriminator value.

Parameters:

discrValue - the discriminator value

getDelimiter

public java.lang.String getDelimiter()

Gets the default delimiter.

Specified by:

getDelimiter in interface FlexfieldDef

Returns:

the default delimiter

setDelimiter

protected void setDelimiter(java.lang.String d)

Sets the delimiter of the flexfield.

Parameters:

d - the delimiter

getEntityUsage

public FlexfieldEntityUsage getEntityUsage(java.lang.String entityDefFullName)

Gets a flexfield entity usage.

Specified by:

getEntityUsage in interface FlexfieldDef

Parameters:

entityDefFullName - the key to the model

Returns:

the full name of the entity

setEntityUsage

protected void setEntityUsage(java.lang.String entityDefFullName,
                              FlexfieldEntityUsage feu)

Sets a flexfield entity usage.

Parameters:

entityDefFullName - the full name of the entity

feu - the entity usage

setMonomorphic

protected void setMonomorphic(boolean b)

Sets whether this flexfield is monomorphic. A monomorphic flexfield does not have a discriminator.

Parameters:

b - true if this flexfield is monomorphic

isMonomorphic

public boolean isMonomorphic()

Returns true if this flexfield does not have a discriminator. getDiscriminatorSegmentValues() should return null or an empty list in this case. To retrieve the segments, getSegmentDefs(null) can be called.

Specified by:

isMonomorphic in interface FlexfieldDef

Returns:

true if this flexfield does not have a discriminator

setParameter

protected void setParameter(java.lang.String code,
                            java.lang.Class javaType)

Sets a parameter.

Parameters:

code - the parameter code

javaType - the Java type

getParameterMap

public java.util.Map<java.lang.String,FlexfieldDef.Parameter> getParameterMap()

Gets a map of the flexfield parameters. The keys of the map are the parameter codes.

Specified by:

getParameterMap in interface FlexfieldDef

Returns:

the map of flexfield parameters; an empty map if this flexfield has no parameters

getSegmentLabel

public SegmentLabel getSegmentLabel(java.lang.String labelCode)

Gets a segment label associated with this flexfield.

Specified by:

getSegmentLabel in interface FlexfieldDef

Parameters:

labelCode - the label code

Returns:

the segment label associated with this flexfield; null if the given label code is not defined

getSegmentLabelMap

public java.util.Map<java.lang.String,SegmentLabel> getSegmentLabelMap()

Gets a map that contains all labels defined for this flexfield. The map key is the label code.

Specified by:

getSegmentLabelMap in interface FlexfieldDef

Returns:

a map that contains all labels defined for this flexfield; an empty map if no labels are defined

setSegmentLabelMap

protected void setSegmentLabelMap(java.util.Map<java.lang.String,SegmentLabel> map)

Sets the label map.

Parameters:

map - the label map

setBIEnabled

protected void setBIEnabled(boolean b)

Sets whether this flexfield is BI-enabled.

Parameters:

b - true if this flexfield is BI-enabled

isBIEnabled

public boolean isBIEnabled()

Returns true if this flexfield is BI-enabled.

Specified by:

isBIEnabled in interface FlexfieldDef

Returns:

true if this flexfield is BI-enabled

setTreeStructureCode

protected void setTreeStructureCode(java.lang.String code)

Sets the tree structure code.

Parameters:

code - the tree structure code

getTreeStructureCode

public java.lang.String getTreeStructureCode()

Gets the code of the tree structure associated with this flexfield.

Specified by:

getTreeStructureCode in interface FlexfieldDef

Returns:

the code of the tree structure associated with this flexfield

setBITreeDataViewDefName

protected void setBITreeDataViewDefName(java.lang.String name)

Sets the full name of the BI tree data view definition.

Parameters:

name - the name

getBITreeDataViewDefName

public java.lang.String getBITreeDataViewDefName()

Description copied from interface: FlexfieldDef

Gets the full name of the BI tree data view definition.

Specified by:

getBITreeDataViewDefName in interface FlexfieldDef

Returns:

the full name of the BItree data view definition