oracle.apps.fnd.applcore.flex.runtime.util.bi
Class ModelerBIEnabledSegment

java.lang.Object
  oracle.apps.fnd.applcore.flex.bi.BIEnabledSegment
      oracle.apps.fnd.applcore.flex.runtime.util.bi.ModelerBIEnabledSegment

All Implemented Interfaces:

java.lang.Comparable<BIEnabledSegment>

public class ModelerBIEnabledSegment
extends BIEnabledSegment

A BI-enabled segment for modeling use.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.apps.fnd.applcore.flex.bi.BIEnabledSegment

BIEnabledSegment.ValueDataType, BIEnabledSegment.ValueTable

Field Summary

Fields inherited from class oracle.apps.fnd.applcore.flex.bi.BIEnabledSegment

discrValue, segmentCode

Constructor Summary

protected

ModelerBIEnabledSegment(FlexfieldDef ff, DiscriminatorValue discrValue, SegmentDef seg) Constructs a BI-enabled segment for modeling use.

Method Summary

java.util.List<BISegmentLabel>	getBISegmentLabels() Gets the list of BI segment labels associated with this segment.
java.lang.Object	getDiscriminatorValueKey() Gets the discriminator value key.
SegmentDef	getSegmentDef() Gets the segment definition.
java.lang.String	getTreeCode() Gets the tree code associated with this segment if applicable.
BIEnabledSegment.ValueDataType	getValueDataType() Gets the data type of the values.
java.lang.String	getValueSetCode() Gets the code of the value set used by this segment.
BIEnabledSegment.ValueTable	getValueTable() Gets the table that stores the segment values.

Methods inherited from class oracle.apps.fnd.applcore.flex.bi.BIEnabledSegment

compareTo, equals, getDiscriminatorValue, getSegmentCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelerBIEnabledSegment

protected ModelerBIEnabledSegment(FlexfieldDef ff,
                                  DiscriminatorValue discrValue,
                                  SegmentDef seg)

Constructs a BI-enabled segment for modeling use.

Parameters:

discrValue - the discriminator value

seg - the segment

Throws:

java.lang.NullPointerException - if the given segment is null

java.lang.IllegalArgumentException - if the given flexfield is null

Method Detail

getSegmentDef

public final SegmentDef getSegmentDef()

Gets the segment definition.

Returns:

the segment definition

getDiscriminatorValueKey

public final java.lang.Object getDiscriminatorValueKey()

Gets the discriminator value key.

Returns:

the discriminator value key; null if the discriminator value is null

getValueTable

public BIEnabledSegment.ValueTable getValueTable()

Description copied from class: BIEnabledSegment

Gets the table that stores the segment values.

Specified by:

getValueTable in class BIEnabledSegment

Returns:

the table that stores the segment values

getValueSetCode

public java.lang.String getValueSetCode()

Description copied from class: BIEnabledSegment

Gets the code of the value set used by this segment.

Specified by:

getValueSetCode in class BIEnabledSegment

Returns:

the value set code

getTreeCode

public java.lang.String getTreeCode()

Description copied from class: BIEnabledSegment

Gets the tree code associated with this segment if applicable.

Specified by:

getTreeCode in class BIEnabledSegment

Returns:

the tree code associated with this segment; null if not applicable

getValueDataType

public BIEnabledSegment.ValueDataType getValueDataType()

Description copied from class: BIEnabledSegment

Gets the data type of the values.

Specified by:

getValueDataType in class BIEnabledSegment

Returns:

the data type of the values

getBISegmentLabels

public java.util.List<BISegmentLabel> getBISegmentLabels()

Description copied from class: BIEnabledSegment

Gets the list of BI segment labels associated with this segment. It is possible for the same segment to be associated with multiple labels. This method must not return null.

Specified by:

getBISegmentLabels in class BIEnabledSegment

Returns:

the list of BI segment labels assocaited with this segment; en emptylist if no BI segment label is associated with this segment