|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.5) E22562-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.apps.fnd.applcore.flex.runtime.util.common.KeyFlexfieldDefImpl
public class KeyFlexfieldDefImpl
Definition of a key flexfield.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface oracle.apps.fnd.applcore.flex.runtime.util.common.FlexfieldDef |
---|
FlexfieldDef.MetadataType, FlexfieldDef.Parameter |
Field Summary | |
---|---|
protected static java.lang.String |
_IS_CC_ID_SEGMENT
The name of the property indicating that a segment represents a CCID column. |
protected static java.lang.String |
_IS_DATA_SET_NUMBER_SEGMENT
The name of the property indicating that a segment represents a data set number column. |
protected static java.lang.String |
_IS_SIN_SEGMENT
The name of the property indicating that a segment represents a structure instance number column. |
protected static java.lang.String |
_IS_STRUCTURE_CODE_SEGMENT
The name of the property indicating that a segment represents a structure code column. |
Constructor Summary | |
---|---|
protected |
KeyFlexfieldDefImpl(java.lang.Long appID,
java.lang.String appShortName,
java.lang.String code)
Constructs a key 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.util.Map<java.lang.String,java.lang.String> |
getStructureInstanceCodeToDefCodeMap()
Gets the map from structure instance codes to structure codes. |
java.util.Map<java.lang.Long,java.lang.String> |
getStructureInstanceNumberToCodeMap()
Gets the map from structure instance numbers to structure instance codes. |
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. |
static boolean |
isCCIDSegment(SegmentDef segment)
Returns true if the given segment is a CCID segment. |
boolean |
isCrossValidationRequired()
Returns true if cross validation is required. |
static boolean |
isDataSetNumberSegment(SegmentDef segment)
Returns true if the given segment is a data set number segment. |
boolean |
isDynamicCombinationCreationAllowed()
Returns true if dynamic combination creation is allowed. |
boolean |
isMonomorphic()
Returns true if this flexfield does not have a discriminator. |
static boolean |
isStructureCodeSegment(SegmentDef segment)
Returns true if the given segment is a structure code segment |
static boolean |
isStructureInstanceNumberSegment(SegmentDef segment)
Returns true if the given segment is a structure instance number segment. |
protected static void |
markAsCCIDSegment(SegmentDefImpl segment)
Marks the given segment as a CCID segment. |
protected static void |
markAsDataSetNumberSegment(SegmentDefImpl segment)
Marks the given segment as a data set number segment. |
protected static void |
markAsStructureCodeSegment(SegmentDefImpl segment)
Marks the given segment as a structure code segment. |
protected static void |
markAsStructureInstanceNumberSegment(SegmentDefImpl segment)
Marks the given segment as a structure instance number segment. |
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 |
setCrossValidationRequired(boolean b)
Sets whether cross validation is required. |
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 |
setDynamicCombinationCreationAllowed(boolean b)
Sets whether dynamic combination creation is allowed. |
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. |
protected void |
setStructureInstanceCodeToDefCodeMap(java.util.Map<java.lang.String,java.lang.String> m)
Sets the map from structure instance codes to structure codes. |
protected void |
setStructureInstanceNumberToCodeMap(java.util.Map<java.lang.Long,java.lang.String> m)
Sets the map from structure instance numbers to structure instance codes. |
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 |
Field Detail |
---|
protected static final java.lang.String _IS_CC_ID_SEGMENT
Boolean.TRUE
,
Boolean.FALSE
or null
.
protected static final java.lang.String _IS_SIN_SEGMENT
Boolean.TRUE
, Boolean.FALSE
or null
.
protected static final java.lang.String _IS_STRUCTURE_CODE_SEGMENT
Boolean.TRUE
, Boolean.FALSE
or null
.
protected static final java.lang.String _IS_DATA_SET_NUMBER_SEGMENT
Boolean.TRUE
, Boolean.FALSe
or null
.
Constructor Detail |
---|
protected KeyFlexfieldDefImpl(java.lang.Long appID, java.lang.String appShortName, java.lang.String code)
appID
- the application IDappShortName
- the application short namecode
- the key flexfield codeMethod Detail |
---|
public java.lang.String getType()
getType
in interface FlexfieldDef
public boolean isDynamicCombinationCreationAllowed()
protected void setDynamicCombinationCreationAllowed(boolean b)
b
- true if dynamic combination creation is allowedpublic boolean isCrossValidationRequired()
protected void setCrossValidationRequired(boolean b)
b
- true if cross validation is requiredpublic java.util.Map<java.lang.String,java.lang.String> getStructureInstanceCodeToDefCodeMap()
protected void setStructureInstanceCodeToDefCodeMap(java.util.Map<java.lang.String,java.lang.String> m)
m
- the map from structure instance codes to structure codespublic java.util.Map<java.lang.Long,java.lang.String> getStructureInstanceNumberToCodeMap()
protected void setStructureInstanceNumberToCodeMap(java.util.Map<java.lang.Long,java.lang.String> m)
m
- the map from structure instance numbers to structure instance
codespublic static boolean isCCIDSegment(SegmentDef segment)
segment
- the segment to be checked
public static boolean isStructureInstanceNumberSegment(SegmentDef segment)
segment
- the segment to be checked
public static boolean isStructureCodeSegment(SegmentDef segment)
segment
- the segment to be checked
public static boolean isDataSetNumberSegment(SegmentDef segment)
segment
- the segment to be checked
protected static void markAsCCIDSegment(SegmentDefImpl segment)
segment
- the segment to be markedisCCIDSegment(oracle.apps.fnd.applcore.flex.runtime.util.common.SegmentDef)
protected static void markAsStructureInstanceNumberSegment(SegmentDefImpl segment)
segment
- the segment to be markedprotected static void markAsStructureCodeSegment(SegmentDefImpl segment)
segment
- the segment to be markedisStructureCodeSegment(oracle.apps.fnd.applcore.flex.runtime.util.common.SegmentDef)
protected static void markAsDataSetNumberSegment(SegmentDefImpl segment)
segment
- the segment to be markedpublic java.lang.String getApplicationShortName()
getApplicationShortName
in interface FlexfieldDef
protected void setApplicationID(java.lang.Long id)
id
- the application IDpublic java.lang.Long getApplicationID()
getApplicationID
in interface FlexfieldDef
public java.lang.String getName()
getName
in interface FlexfieldDef
public java.lang.String getDisplayName()
getDisplayName
in interface FlexfieldDef
protected void setDisplayName(java.lang.String s)
s
- the display namepublic java.util.Map<java.lang.String,java.lang.String> getTranslatedDisplayNames()
FlexfieldDef
getTranslatedDisplayNames
in interface FlexfieldDef
FlexfieldDef.getDisplayName()
protected void setTranslatedDisplayNames(java.util.Map<java.lang.String,java.lang.String> map)
map
- the translationsprotected void setApplicationModuleName(java.lang.String name)
name
- the name of the application modulepublic java.lang.String getApplicationModuleName()
getApplicationModuleName
in interface FlexfieldDef
public java.lang.String getApplicationName()
getApplicationName
in interface FlexfieldDef
protected void setApplicationName(java.lang.String name)
name
- the applicatio namepublic java.lang.String getBaseLanguage()
FlexfieldDef
getBaseLanguage
in interface FlexfieldDef
protected void setBaseLanguage(java.lang.String lang)
lang
- the base languagepublic java.util.List<java.lang.String> getInstalledLanguages()
FlexfieldDef
getInstalledLanguages
in interface FlexfieldDef
protected void setInstalledLanguages(java.util.List<java.lang.String> langs)
langs
- the list of installed languagespublic java.lang.String getUsageName()
getUsageName
in interface FlexfieldDef
protected void setUsageName(java.lang.String usageName)
usageName
- the usage namepublic java.lang.String getUsageType()
getUsageType
in interface FlexfieldDef
protected void setUsageType(java.lang.String type)
type
- the usage typepublic java.lang.String getTableName()
getTableName
in interface FlexfieldDef
public void setTableName(java.lang.String tableName)
tableName
- the database object namepublic ContextValueDef[] getDiscriminatorSegmentValues()
null
, no values have been defined
for the discriminator segment.
getDiscriminatorSegmentValues
in interface FlexfieldDef
protected void setDiscriminatorSegmentValues(ContextValueDef[] values)
values
- the discriminator segment valuespublic SegmentDefList getSegmentDefs(java.lang.Object discrValue)
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.
getSegmentDefs
in interface FlexfieldDef
discrValue
- the discriminator value; null
to get
global segments
null
if a segment list has not been defined for the given
discriminator valueprotected void addSegmentDefList(java.lang.Object discrValue, SegmentDefList list)
discrValue
- the discriminator valuelist
- the segment definition listprotected void removeSegmentDefList(java.lang.Object discrValue)
discrValue
- the discriminator valuepublic java.lang.String getDelimiter()
getDelimiter
in interface FlexfieldDef
protected void setDelimiter(java.lang.String d)
d
- the delimiterpublic FlexfieldEntityUsage getEntityUsage(java.lang.String entityDefFullName)
getEntityUsage
in interface FlexfieldDef
entityDefFullName
- the key to the model
protected void setEntityUsage(java.lang.String entityDefFullName, FlexfieldEntityUsage feu)
entityDefFullName
- the full name of the entityfeu
- the entity usageprotected void setMonomorphic(boolean b)
b
- true if this flexfield is monomorphicpublic boolean isMonomorphic()
getDiscriminatorSegmentValues()
should return null or an
empty list in this case. To retrieve the segments,
getSegmentDefs(null)
can be called.
isMonomorphic
in interface FlexfieldDef
protected void setParameter(java.lang.String code, java.lang.Class javaType)
code
- the parameter codejavaType
- the Java typepublic java.util.Map<java.lang.String,FlexfieldDef.Parameter> getParameterMap()
getParameterMap
in interface FlexfieldDef
public SegmentLabel getSegmentLabel(java.lang.String labelCode)
getSegmentLabel
in interface FlexfieldDef
labelCode
- the label code
public java.util.Map<java.lang.String,SegmentLabel> getSegmentLabelMap()
getSegmentLabelMap
in interface FlexfieldDef
protected void setSegmentLabelMap(java.util.Map<java.lang.String,SegmentLabel> map)
map
- the label mapprotected void setBIEnabled(boolean b)
b
- true if this flexfield is BI-enabledpublic boolean isBIEnabled()
isBIEnabled
in interface FlexfieldDef
protected void setTreeStructureCode(java.lang.String code)
code
- the tree structure codepublic java.lang.String getTreeStructureCode()
getTreeStructureCode
in interface FlexfieldDef
protected void setBITreeDataViewDefName(java.lang.String name)
name
- the namepublic java.lang.String getBITreeDataViewDefName()
FlexfieldDef
getBITreeDataViewDefName
in interface FlexfieldDef
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.5) E22562-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |