oracle.apps.fnd.applcore.flex.runtime
Class OAEntityFlexfieldUsage

java.lang.Object
  oracle.apps.fnd.applcore.flex.runtime.OAEntityFlexfieldUsage

public final class OAEntityFlexfieldUsage
extends java.lang.Object

Internal: Applications should not use this class. Information about the usage of a flexfield in an entity. Typical information includes the application, code, and usage code of the flexfield, and information gathered from developers at design-time such as the name of the structure instance number attribute.

This class is used by both the design time and dt@rt (design time at runtime) to access the properties.

Nested Class Summary

static class

OAEntityFlexfieldUsage.Configuration Configuration of a flexfield entity usage.

Method Summary

java.util.Map<OAEntityFlexfieldUsage.Configuration,java.lang.String>	getConfigurationMap() Gets the configuration settings.
static java.lang.String	getConfigurationPropertyName(java.lang.String id, OAEntityFlexfieldUsage.Configuration conf) Constructs the name of the property for a configuration setting.
java.util.Map<java.lang.String,java.lang.String>	getFlexfieldParameterMap() Gets the flexfield parameters.
static java.lang.String	getFlexfieldParameterPropertyName(java.lang.String id, java.lang.String paramCode) Constructs the name of the property for a flexfield parameter of a specific flexfield usage in an entity.
static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.String>>>	getFlexfieldParameters(java.util.Map propertyMap) Gets all flexfield parameters from a map of properties.
java.lang.String	getID() Gets the identifier of the flexfield table usage that owns this entity usage.
static java.lang.String	getID(java.lang.String flexfieldType, java.lang.String appShortName, java.lang.String flexfieldCode, java.lang.String usageCode, java.lang.String tableName) Constructs an ID to identify a flexfield usage in an entity.
static OAEntityFlexfieldUsage	getInstance(java.lang.String id, java.util.Map<?,?> map) Constructs an instance of the flexfield usage based on a list of properties.
static OAEntityFlexfieldUsage	getInstance(java.lang.String id, oracle.jbo.common.NamedObjectImpl obj) Constructs an instance of the flexfield usage based on the properties of a named object.
static java.util.List<java.lang.String>	getPropertyNames(java.lang.String id, java.util.Map<?,?> map) Gets the list of properties relevant to the given ID.

Methods inherited from class java.lang.Object

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

Method Detail

getID

public final java.lang.String getID()

Gets the identifier of the flexfield table usage that owns this entity usage.

Returns:

the identifier of the flexfield table usage

getFlexfieldParameterMap

public java.util.Map<java.lang.String,java.lang.String> getFlexfieldParameterMap()

Gets the flexfield parameters.

Returns:

the flexfield parameters in a map, where the names are the parameter codes and the values are the expressions. An empty map is returned if no flexfield parameter is set.

getConfigurationMap

public java.util.Map<OAEntityFlexfieldUsage.Configuration,java.lang.String> getConfigurationMap()

Gets the configuration settings.

Returns:

the configuration settings in a map; an empty map if no configuration setting is set

getConfigurationPropertyName

public static java.lang.String getConfigurationPropertyName(java.lang.String id,
                                                            OAEntityFlexfieldUsage.Configuration conf)

Constructs the name of the property for a configuration setting.

Parameters:

id - the identifier of the flexfield table usage

conf - the configuration setting

Returns:

the name of the property

Throws:

java.lang.IllegalArgumentException - if the given id or configuration is null

getFlexfieldParameterPropertyName

public static java.lang.String getFlexfieldParameterPropertyName(java.lang.String id,
                                                                 java.lang.String paramCode)

Constructs the name of the property for a flexfield parameter of a specific flexfield usage in an entity.

Parameters:

id - the identifier of the flexfield table usage

paramCode - the parameter code

Returns:

the name of the property

Throws:

java.lang.IllegalArgumentException - if the given id or parameter code is null

getID

public static java.lang.String getID(java.lang.String flexfieldType,
                                     java.lang.String appShortName,
                                     java.lang.String flexfieldCode,
                                     java.lang.String usageCode,
                                     java.lang.String tableName)

Constructs an ID to identify a flexfield usage in an entity. Note that this ID is only locally unique within an entity. All entities that share the same table usage also share the same ID.

Parameters:

flexfieldType - "DFF" or "KFF" or "EFF"

appShortName - the application short name

flexfieldCode - the flexfield code

usageCode - the usage code

tableName - the database object name

Returns:

the id for the given flexfield usage

getInstance

public static OAEntityFlexfieldUsage getInstance(java.lang.String id,
                                                 oracle.jbo.common.NamedObjectImpl obj)

Constructs an instance of the flexfield usage based on the properties of a named object.

Parameters:

id - the flexfield table usage identifier

obj - the named object

Returns:

an instance of the flexfield usage

Throws:

java.lang.IllegalArgumentException - if the given id or named object is null

getPropertyNames

public static java.util.List<java.lang.String> getPropertyNames(java.lang.String id,
                                                                java.util.Map<?,?> map)

Gets the list of properties relevant to the given ID.

Parameters:

id - the flexfield table usage identifier

map - the map of properties

Returns:

the list of properties relevant to the given ID; empty map if no property is found for the given ID

Throws:

java.lang.IllegalArgumentException - if the given ID or property map is null

getInstance

public static OAEntityFlexfieldUsage getInstance(java.lang.String id,
                                                 java.util.Map<?,?> map)

Constructs an instance of the flexfield usage based on a list of properties.

Parameters:

id - the flexfield table usage identifier

map - the properties

Returns:

an instance of the flexfield usage

Throws:

java.lang.IllegalArgumentException - if the given ID or property map is null

getFlexfieldParameters

public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.String>>> getFlexfieldParameters(java.util.Map propertyMap)

Gets all flexfield parameters from a map of properties. The return map has the following structure:

{LocalID={ParameterCode=[AttrName, AttrName, ...]}}

where the local ID is an identifier to a flexfield table usage, previously created by method getID.

Parameters:

propertyMap -

Returns:

the flexfield parameters; empty map if no parameter is found