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

All Known Implementing Classes:

SegmentDefImpl

public interface SegmentDef

Definition of a flexfield segment.

Nested Class Summary

static interface	SegmentDef.Column A database table column.
static interface	SegmentDef.Operator A custom operator for this segment.

Method Summary

SegmentDef.Column	getColumn() Gets the database table column associated with this segment.
java.util.List<SegmentDef.Operator>	getCustomOperators() Gets the list of custom operators.
java.lang.String	getDefaultValue() Gets the default value of the segment.
java.lang.String	getDefaultValueType() Gets the type of the default value.
java.lang.String	getDerivationValue() Gets the flexfield parameter code this segment value is derived from.
java.lang.String	getFormattedDefaultValue(java.lang.Class targetJavaType) Gets the formatted default value for runtime use.
java.lang.String	getIndexedFlag() Gets the Indexed Flag
java.lang.String[]	getLabelCodes() Gets the list of segment labels associated with this segment.
java.lang.String	getMultiRowUniqueKeyFlag() Gets the MultiRow Unique Key Flag
java.lang.String	getName() Gets the name of this segment.
java.lang.Object	getProperty(java.lang.String pname) Gets a property of this segment.
java.lang.String[]	getPropertyNames() Gets a list of the names of the properties currently set on this segment.
java.lang.String	getQueryRequiredType() Gets the query required type.
java.lang.String	getRangeType() Gets the range type.
java.lang.String	getTreeCode() Gets the tree code associated with this segment.
UIHints	getUIHints() Gets the hints for rendering the user interface.
java.lang.String	getUOMClass() Gets the UOM Class
Validator	getValidator() Gets the validator associated with this segment.
boolean	isBIEnabled() Returns true if this segment is BI-enabled.
boolean	isDiscriminator() Returns true if this segment is a discriminator.
boolean	isGlobal() Returns true if this segment is a global segment.
boolean	isMandatory() Returns true if this segment is mandatory.
boolean	isValueDescriptionDisplayed() Returns true if the description of the segment value should be displayed along with the segment.

Method Detail

getName

java.lang.String getName()

Gets the name of this segment.

Returns:

the name of this segment

isGlobal

boolean isGlobal()

Returns true if this segment is a global segment.

Returns:

true if this segment is a global segment

isDiscriminator

boolean isDiscriminator()

Returns true if this segment is a discriminator.

Returns:

true if this segment is a discriminator

getUIHints

UIHints getUIHints()

Gets the hints for rendering the user interface.

Returns:

the hints for the UI

getProperty

java.lang.Object getProperty(java.lang.String pname)

Gets a property of this segment.

Parameters:

pname - the name of the property

Returns:

the value of the property; null if the property does not exist

getPropertyNames

java.lang.String[] getPropertyNames()

Gets a list of the names of the properties currently set on this segment.

Returns:

the list of property names; null if no properties are set

getValidator

Validator getValidator()

Gets the validator associated with this segment.

Returns:

the validator associated with this segment; null if no validator is associated with this segment

isMandatory

boolean isMandatory()

Returns true if this segment is mandatory.

Returns:

true if this segment is mandatory.

getColumn

SegmentDef.Column getColumn()

Gets the database table column associated with this segment.

Returns:

the database table column associated with this segment

getDerivationValue

java.lang.String getDerivationValue()

Gets the flexfield parameter code this segment value is derived from.

Returns:

the flexfield parameter code

getRangeType

java.lang.String getRangeType()

Gets the range type.

Returns:

the range type; null if not set

getDefaultValue

java.lang.String getDefaultValue()

Gets the default value of the segment.

Returns:

the default value

getFormattedDefaultValue

java.lang.String getFormattedDefaultValue(java.lang.Class targetJavaType)

Gets the formatted default value for runtime use.

Parameters:

targetJavaType - the Java type of the attribute where the default value will be applied

Returns:

the formatted default value

getDefaultValueType

java.lang.String getDefaultValueType()

Gets the type of the default value.

Returns:

the type of the default value

getLabelCodes

java.lang.String[] getLabelCodes()

Gets the list of segment labels associated with this segment.

Returns:

the list of segment labels

getCustomOperators

java.util.List<SegmentDef.Operator> getCustomOperators()

Gets the list of custom operators.

Returns:

the list of custom operators

getUOMClass

java.lang.String getUOMClass()

Gets the UOM Class

Returns:

the UOM Class

getIndexedFlag

java.lang.String getIndexedFlag()

Gets the Indexed Flag

Returns:

the Indexed Flag

isBIEnabled

boolean isBIEnabled()

Returns true if this segment is BI-enabled.

Returns:

true if this segment is BI-enabled

getTreeCode

java.lang.String getTreeCode()

Gets the tree code associated with this segment.

Returns:

the tree code

getMultiRowUniqueKeyFlag

java.lang.String getMultiRowUniqueKeyFlag()

Gets the MultiRow Unique Key Flag

Returns:

the MultiRow Unique Key Flag

getQueryRequiredType

java.lang.String getQueryRequiredType()

Gets the query required type. The types are defined in oracle.apps.fnd.applcore.flex.common.util.QueryRequiredType

Returns:

the query required type; null if not applicable

See Also:

QueryRequiredType

isValueDescriptionDisplayed

boolean isValueDescriptionDisplayed()

Returns true if the description of the segment value should be displayed along with the segment.

Returns:

true if the description of the segment value should be displayed along with the value