oracle.apps.fnd.applcore.flex.runtime.util.common
Interface FlexfieldDef

All Known Implementing Classes:

DescriptiveFlexfieldDefImpl, ExtensibleFlexfieldDefImpl, KeyFlexfieldDefImpl

public interface FlexfieldDef

Definition of a flexfield.

Nested Class Summary

static class	FlexfieldDef.MetadataType Metadata type.
static interface	FlexfieldDef.Parameter An external data source that can be used in value sets, defaulting and derivation.

Method Summary

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.

Method Detail

getApplicationShortName

java.lang.String getApplicationShortName()

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

Returns:

the application short name

getApplicationID

java.lang.Long getApplicationID()

Gets the application ID with which this flexfield is associated.

Returns:

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

getApplicationName

java.lang.String getApplicationName()

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

Returns:

the full name of the application

getInstalledLanguages

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

Gets the list of installed languages.

Returns:

the list of installed languages

getBaseLanguage

java.lang.String getBaseLanguage()

Gets the base language.

Returns:

the base language code; null if not defined

getType

java.lang.String getType()

Gets the type of this flexfield.

Returns:

the type of this flexfield

getName

java.lang.String getName()

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

Returns:

the name of this flexfield

getDisplayName

java.lang.String getDisplayName()

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

Returns:

the display name of this flexfield

getTranslatedDisplayNames

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

Gets the translations of the display names.

Returns:

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

See Also:

getDisplayName()

getUsageName

java.lang.String getUsageName()

Gets the name of the flexfield usage.

Returns:

the name of the flexfield usage

getUsageType

java.lang.String getUsageType()

Gets the type of the usage.

Returns:

the type of the usage

getTableName

java.lang.String getTableName()

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

Returns:

the name of the database object

getEntityUsage

FlexfieldEntityUsage getEntityUsage(java.lang.String entityDefFullName)

Gets a flexfield entity usage.

Parameters:

entityDefFullName - the key to the model

Returns:

the full name of the entity

getDelimiter

java.lang.String getDelimiter()

Gets the default delimiter.

Returns:

the default delimiter

getDiscriminatorSegmentValues

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.

Returns:

the list of values of a discriminator segment

isMonomorphic

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.

Returns:

true if this flexfield does not have a discriminator

getSegmentDefs

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.

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

getApplicationModuleName

java.lang.String getApplicationModuleName()

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

Returns:

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

getParameterMap

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.

Returns:

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

getSegmentLabel

SegmentLabel getSegmentLabel(java.lang.String labelCode)

Gets a segment label associated with this flexfield.

Parameters:

labelCode - the label code

Returns:

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

getSegmentLabelMap

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.

Returns:

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

isBIEnabled

boolean isBIEnabled()

Returns true if this flexfield is BI-enabled.

Returns:

true if this flexfield is BI-enabled

getTreeStructureCode

java.lang.String getTreeStructureCode()

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

Returns:

the code of the tree structure associated with this flexfield

getBITreeDataViewDefName

java.lang.String getBITreeDataViewDefName()

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

Returns:

the full name of the BItree data view definition