Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-05

oracle.apps.fnd.applcore.flex.bi
Class BIEnabledSegment

java.lang.Object
  extended by oracle.apps.fnd.applcore.flex.bi.BIEnabledSegment
All Implemented Interfaces:
java.lang.Comparable<BIEnabledSegment>
Direct Known Subclasses:
ModelerBIEnabledSegment

public abstract class BIEnabledSegment
extends java.lang.Object
implements java.lang.Comparable<BIEnabledSegment>

A BI-enabled segment.


Nested Class Summary
static class BIEnabledSegment.ValueDataType
          The data type of the segment values.
static class BIEnabledSegment.ValueTable
          The table that stores segment values.
 
Field Summary
protected  DiscriminatorValue discrValue
          The value to identify the context or structure instance where this segment is defined.
protected  java.lang.String segmentCode
          The segment code.
 
Constructor Summary
protected BIEnabledSegment(DiscriminatorValue discrValue, java.lang.String segmentCode)
          Constructs a BI enabled segment.
 
Method Summary
 int compareTo(BIEnabledSegment seg)
           
 boolean equals(java.lang.Object o)
           
abstract  java.util.List<BISegmentLabel> getBISegmentLabels()
          Gets the list of BI segment labels associated with this segment.
 DiscriminatorValue getDiscriminatorValue()
          Gets the value to identify the context or structure instance where this segment is defined.
 java.lang.String getSegmentCode()
          Gets the segment code.
abstract  java.lang.String getTreeCode()
          Gets the tree code associated with this segment if applicable.
abstract  BIEnabledSegment.ValueDataType getValueDataType()
          Gets the data type of the values.
abstract  java.lang.String getValueSetCode()
          Gets the code of the value set used by this segment.
abstract  BIEnabledSegment.ValueTable getValueTable()
          Gets the table that stores the segment values.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

discrValue

protected final DiscriminatorValue discrValue
The value to identify the context or structure instance where this segment is defined.


segmentCode

protected final java.lang.String segmentCode
The segment code.

Constructor Detail

BIEnabledSegment

protected BIEnabledSegment(DiscriminatorValue discrValue,
                           java.lang.String segmentCode)
Constructs a BI enabled segment.

Parameters:
discrValue - the value to identify the context or structure instance where this segment is defined; null if this segment is a global segment
segmentCode - the segment code
Throws:
java.lang.IllegalArgumentException - if the given segment code is null
Method Detail

getDiscriminatorValue

public final DiscriminatorValue getDiscriminatorValue()
Gets the value to identify the context or structure instance where this segment is defined.

Returns:
the value to identify the context or structure instance where this segment is defined; null if this is a global segment

getSegmentCode

public final java.lang.String getSegmentCode()
Gets the segment code.

Returns:
the segment code, which is never null

getValueTable

public abstract BIEnabledSegment.ValueTable getValueTable()
Gets the table that stores the segment values.

Returns:
the table that stores the segment values

getValueSetCode

public abstract java.lang.String getValueSetCode()
Gets the code of the value set used by this segment.

Returns:
the value set code

getTreeCode

public abstract java.lang.String getTreeCode()
Gets the tree code associated with this segment if applicable.

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

getValueDataType

public abstract BIEnabledSegment.ValueDataType getValueDataType()
Gets the data type of the values.

Returns:
the data type of the values

getBISegmentLabels

public abstract java.util.List<BISegmentLabel> getBISegmentLabels()
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.

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

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

compareTo

public int compareTo(BIEnabledSegment seg)
Specified by:
compareTo in interface java.lang.Comparable<BIEnabledSegment>

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-05

Copyright © 2012 Oracle. All Rights Reserved.