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

java.lang.Object
  oracle.apps.fnd.applcore.flex.bi.BIEnabledFlexfield<BIFlattenedSegment<BIEnabledSegment>,BIEnabledSegment>
      oracle.apps.fnd.applcore.flex.bi.BIEnabledKeyFlexfield

public class BIEnabledKeyFlexfield
extends BIEnabledFlexfield<BIFlattenedSegment<BIEnabledSegment>,BIEnabledSegment>

A BI-enabled key flexfield.

Field Summary

protected java.lang.Long	applicationId The application ID.
protected java.util.List<DiscriminatorValue>	discrValues The list of discriminator values.
protected java.lang.String	flexfieldCode The flexfield code.
protected java.util.List<BIEnabledSegment>	globalSegments The list of BI-enabled global segments.
protected java.util.Map<DiscriminatorValue,java.util.List<BIEnabledSegment>>	segmentMap The list of BI-enabled segments in each subtype.

Constructor Summary

BIEnabledKeyFlexfield(java.lang.Long appId, java.lang.String code)
Constructs a BIEnabledKeyFlexfield object for an existing flexfield in the repository.

Method Summary

protected oracle.jbo.ApplicationModule	createServiceAppModule() Creates the service application module.
BIFlattenedFlexfield<BIFlattenedSegment<BIEnabledSegment>,BIEnabledSegment>	flatten() Flattens this flexfield.
java.util.List<BIEnabledSegment>	getBIEnabledGlobalSegments() Gets the BI-enabled global segments.
java.util.List<BIEnabledSegment>	getBIEnabledSegments(DiscriminatorValue discrValue) Gets the BI-enabled segments of a particular subtype.
java.util.List<DiscriminatorValue>	getDiscriminatorValues() Gets the list of discriminator values.
protected BIEnabledSegment.ValueDataType	getValueDataType(java.lang.String valueSetCode, java.lang.Object dataType) Gets the value data type acceptable to BIEnabledSegment.
protected BIEnabledSegment.ValueTable	getValueTable(java.lang.String valueSetCode, java.lang.Object validationType) Gets the table that provides the values.
protected boolean	load(oracle.jbo.ApplicationModule am) Loads the flexfield from the service.

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

flatten

Methods inherited from class java.lang.Object

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

Field Detail

applicationId

protected final java.lang.Long applicationId

The application ID.

flexfieldCode

protected final java.lang.String flexfieldCode

The flexfield code.

discrValues

protected java.util.List<DiscriminatorValue> discrValues

The list of discriminator values.

globalSegments

protected java.util.List<BIEnabledSegment> globalSegments

The list of BI-enabled global segments.

segmentMap

protected java.util.Map<DiscriminatorValue,java.util.List<BIEnabledSegment>> segmentMap

The list of BI-enabled segments in each subtype. The keys of the map should be the same as the elements in discrValues.

Constructor Detail

BIEnabledKeyFlexfield

public BIEnabledKeyFlexfield(java.lang.Long appId,
                             java.lang.String code)

Constructs a BIEnabledKeyFlexfield object for an existing flexfield in the repository. This constructor does not check whether this flexfield exists or is valid. Exceptions will be thrown later when the accessors are called.

Parameters:

appId - the application ID

code - the key flexfield code

Method Detail

createServiceAppModule

protected oracle.jbo.ApplicationModule createServiceAppModule()

Creates the service application module.

Returns:

the service application module

load

protected boolean load(oracle.jbo.ApplicationModule am)

Loads the flexfield from the service.

Parameters:

am - the application module returned by createServiceAppModule.

Returns:

true if the flexfield is successfully loaded; false if the flexfield is not BI-enabled or does not allow flattening

flatten

public BIFlattenedFlexfield<BIFlattenedSegment<BIEnabledSegment>,BIEnabledSegment> flatten()

Flattens this flexfield. If this flexfield is not BI-enabled, the return flattened flexfield is blank.

Returns:

the flattened flexfield

Throws:

java.lang.IllegalStateException - if this flexfield cannot be found, or an error occurs during loading the flexfield

getValueDataType

protected BIEnabledSegment.ValueDataType getValueDataType(java.lang.String valueSetCode,
                                                          java.lang.Object dataType)

Gets the value data type acceptable to BIEnabledSegment.

Parameters:

valueSetCode - the value set code

dataType - the data type from the metadata

Returns:

the value data type

getValueTable

protected BIEnabledSegment.ValueTable getValueTable(java.lang.String valueSetCode,
                                                    java.lang.Object validationType)

Gets the table that provides the values.

Parameters:

valueSetCode - the value set code

validationType - the validation type

Returns:

the table that provides the values

getBIEnabledGlobalSegments

public java.util.List<BIEnabledSegment> getBIEnabledGlobalSegments()

Description copied from class: BIEnabledFlexfield

Gets the BI-enabled global segments.

Specified by:

getBIEnabledGlobalSegments in class BIEnabledFlexfield<BIFlattenedSegment<BIEnabledSegment>,BIEnabledSegment>

Returns:

the BI-enabled global segments; an empty list if there is no BI-enabled global segments.

getDiscriminatorValues

public java.util.List<DiscriminatorValue> getDiscriminatorValues()

Description copied from class: BIEnabledFlexfield

Gets the list of discriminator values.

Specified by:

getDiscriminatorValues in class BIEnabledFlexfield<BIFlattenedSegment<BIEnabledSegment>,BIEnabledSegment>

Returns:

the list of discriminator values; an empty list if there is no discriminator

getBIEnabledSegments

public java.util.List<BIEnabledSegment> getBIEnabledSegments(DiscriminatorValue discrValue)

Description copied from class: BIEnabledFlexfield

Gets the BI-enabled segments of a particular subtype. This list should not include the global segments.

Specified by:

getBIEnabledSegments in class BIEnabledFlexfield<BIFlattenedSegment<BIEnabledSegment>,BIEnabledSegment>

Parameters:

discrValue - the discriminator value that denotes the subtype

Returns:

the list of BI-enabled segments of the subtype