oracle.apps.fnd.applcp.migrate.modeler.common
Interface ValueSetDef

All Known Subinterfaces:

CustomValueSetDef

All Known Implementing Classes:

CustomValueSetDefImpl, ValueSetDefImpl

public interface ValueSetDef

A set of values.

Nested Class Summary

static class

ValueSetDef.ValueSetType Value-Set types.

Field Summary

static long

TRANSIENT_VALUE_SET_ID The ID for all transient value-set definitions.

Method Summary

ValueSetUsage	createUsage(boolean isNullAllowed) Creates a value-set usage of this value-set definition.
java.lang.String	getCode() Gets the code of the value set.
java.lang.String	getDataSecurityViewCriteriaName() Gets the name of the view criteria used for data security.
long	getID() Gets the ID of the value set.
java.lang.Long	getReferenceValueSetID() Gets the ID of the value-set referenced by this value-set.
java.lang.String[]	getSegmentLabelCodes() Gets the segment label codes associated with this value-set definition.
ValueSetDef.ValueSetType	getType() Gets the type of the value set.
java.lang.String	getUIControlType() Gets the preferred type of the UI control for this value set.
ValueType	getValueType() Gets the type of the values in this value set.
boolean	isDiscriminator() Whether this value set holds the discriminator values.
boolean	isJavaTypeSupported(java.lang.Class type) Checks whether values of a Java type are supported by this value set.
boolean	isTransient() Whether this value-set definition is transient.

Field Detail

TRANSIENT_VALUE_SET_ID

static final long TRANSIENT_VALUE_SET_ID

The ID for all transient value-set definitions.

See Also:

Constant Field Values

Method Detail

getID

long getID()

Gets the ID of the value set. If the ID is TRANSIENT_VALUE_SET_ID, this value set is a transient value set. All transient value sets share the same ID.

Returns:

the ID of the value set

getCode

java.lang.String getCode()

Gets the code of the value set.

Returns:

the code of the value set

getType

ValueSetDef.ValueSetType getType()

Gets the type of the value set.

Returns:

the type of the value set

getValueType

ValueType getValueType()

Gets the type of the values in this value set.

Returns:

the type of the values

getUIControlType

java.lang.String getUIControlType()

Gets the preferred type of the UI control for this value set.

Returns:

the preferred type of the UI control

getReferenceValueSetID

java.lang.Long getReferenceValueSetID()

Gets the ID of the value-set referenced by this value-set.

Returns:

the reference value-set ID; null if this value-set does not reference any other value set

isTransient

boolean isTransient()

Whether this value-set definition is transient.

Returns:

true if this value-set definition is transient

isDiscriminator

boolean isDiscriminator()

Whether this value set holds the discriminator values.

Returns:

true if this value set holds the discriminator values

createUsage

ValueSetUsage createUsage(boolean isNullAllowed)

Creates a value-set usage of this value-set definition.

Parameters:

isNullAllowed - true if null value is allowed

Returns:

a value-set usage

getSegmentLabelCodes

java.lang.String[] getSegmentLabelCodes()

Gets the segment label codes associated with this value-set definition. This is not a complete list. This list is specific to a flexfield that uses this value set. This list is used to determine which value attributes this value set should provide for a given flexfield.

Returns:

the segment label codes associated with this value-set definition; an empty array if no label code is involved.

isJavaTypeSupported

boolean isJavaTypeSupported(java.lang.Class type)

Checks whether values of a Java type are supported by this value set.

Parameters:

type - the JAva type

Returns:

true if values of the given Java type are supported by this value set

getDataSecurityViewCriteriaName

java.lang.String getDataSecurityViewCriteriaName()

Gets the name of the view criteria used for data security.

Returns:

the name of the view criteria used for data security; null if this value set is not secured