oracle.epm.api.model

Enum MemberNameType

java.lang.Object

java.lang.Enum<MemberNameType>

oracle.epm.api.model.MemberNameType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MemberNameType>

public enum MemberNameType
extends java.lang.Enum<MemberNameType>

An enumeration containing a list of valid member name types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ESSBASE_NAME
MEMBER_NAME
UNIQUE_ESSBASE_NAME
UNIQUE_NAME

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getName(DataGrid.HeaderCell headerCell) Returns the member name of the specified header cell based on member name type.
abstract java.lang.String	getName(com.hyperion.planning.sql.HspFormMember formMember) Returns the member name of the specified form member based on member name type.
abstract java.lang.String	getName(com.hyperion.planning.sql.HspMember member) Returns the member name of the specified member based on member name type.
java.util.List<java.lang.String>	getNames(com.hyperion.planning.sql.HspMember... members) Returns the member name of the specified members based on the member name type
static MemberNameType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MemberNameType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ESSBASE_NAME

public static final MemberNameType ESSBASE_NAME

MEMBER_NAME

public static final MemberNameType MEMBER_NAME

UNIQUE_ESSBASE_NAME

public static final MemberNameType UNIQUE_ESSBASE_NAME

UNIQUE_NAME

public static final MemberNameType UNIQUE_NAME

Method Detail

getName

public abstract java.lang.String getName(DataGrid.HeaderCell headerCell)

Returns the member name of the specified header cell based on member name type.

Parameters:

headerCell - a header cell or null

Returns:

the member name of the specified header cell based on member name type.

getName

public abstract java.lang.String getName(com.hyperion.planning.sql.HspFormMember formMember)

Returns the member name of the specified form member based on member name type.

Parameters:

formMember - a form member or null

Returns:

the member name of the specified form member based on member name type.

getName

public abstract java.lang.String getName(com.hyperion.planning.sql.HspMember member)

Returns the member name of the specified member based on member name type.

Parameters:

member - a member or null

Returns:

the member name of the specified member based on member name type.

getNames

public java.util.List<java.lang.String> getNames(com.hyperion.planning.sql.HspMember... members)

Returns the member name of the specified members based on the member name type

Parameters:

members - an array of members or null

Returns:

a list containing the member names of the specified members based on member name type

valueOf

public static MemberNameType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

values

public static MemberNameType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MemberNameType c : MemberNameType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared