com.essbase.api.metadata

Class IEssMember.EEssShareOption

java.lang.Object

com.essbase.api.metadata.IEssMember.EEssShareOption

All Implemented Interfaces:

IEssBaseObject, IEssEnum

Enclosing interface:

IEssMember

public static final class IEssMember.EEssShareOption
extends java.lang.Object
implements IEssEnum

EEssShareOption class is the enumeration of data storage share options.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Field Summary

Fields

Modifier and Type	Field and Description
static IEssMember.EEssShareOption	DYNAMIC_CALC
static IEssMember.EEssShareOption	DYNAMIC_CALC_AND_STORE
static int	DYNAMIC_CALC_AND_STORE_INT_VALUE
static int	DYNAMIC_CALC_INT_VALUE
static IEssMember.EEssShareOption	EXTENDED_SHARED_MEMBER
static int	EXTENDED_SHARED_MEMBER_INT_VALUE
static IEssMember.EEssShareOption	LABEL_ONLY
static int	LABEL_ONLY_INT_VALUE
static IEssMember.EEssShareOption	NEVER_SHARE
static int	NEVER_SHARE_INT_VALUE
static IEssMember.EEssShareOption	SHARED_MEMBER
static int	SHARED_MEMBER_INT_VALUE
static IEssMember.EEssShareOption	STORE_DATA
static int	STORE_DATA_INT_VALUE

Constructor Summary

Constructors

Constructor and Description
EEssShareOption()

Method Summary

Modifier and Type	Method and Description
IEssEnum	fromInt(int intValue) Gets the IEssEnum from the int value.
IEssEnum	fromString(java.lang.String strValue) Gets the IEssEnum from the String display value.
int	getCountPossibleValues() Gets the count of possible values of the enumeration.
java.lang.String[]	getPossibleValues() Gets the list of possible values of the enumeration.
int	intValue() Gets the int value of the IEssEnum.
static IEssMember.EEssShareOption	sm_fromInt(int intValue) Gets an enumeration object from its int value.
static IEssMember.EEssShareOption	sm_fromString(java.lang.String strValue) Gets an enumeration object from its string display value.
static IEssMember.EEssShareOption[]	sm_values() Gets all the enumeration objects.
java.lang.String	stringValue() Gets the String display value of the IEssEnum.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STORE_DATA

public static final IEssMember.EEssShareOption STORE_DATA

NEVER_SHARE

public static final IEssMember.EEssShareOption NEVER_SHARE

LABEL_ONLY

public static final IEssMember.EEssShareOption LABEL_ONLY

SHARED_MEMBER

public static final IEssMember.EEssShareOption SHARED_MEMBER

DYNAMIC_CALC_AND_STORE

public static final IEssMember.EEssShareOption DYNAMIC_CALC_AND_STORE

DYNAMIC_CALC

public static final IEssMember.EEssShareOption DYNAMIC_CALC

EXTENDED_SHARED_MEMBER

public static final IEssMember.EEssShareOption EXTENDED_SHARED_MEMBER

STORE_DATA_INT_VALUE

public static final int STORE_DATA_INT_VALUE

See Also:

Constant Field Values

NEVER_SHARE_INT_VALUE

public static final int NEVER_SHARE_INT_VALUE

See Also:

Constant Field Values

LABEL_ONLY_INT_VALUE

public static final int LABEL_ONLY_INT_VALUE

See Also:

Constant Field Values

SHARED_MEMBER_INT_VALUE

public static final int SHARED_MEMBER_INT_VALUE

See Also:

Constant Field Values

DYNAMIC_CALC_AND_STORE_INT_VALUE

public static final int DYNAMIC_CALC_AND_STORE_INT_VALUE

See Also:

Constant Field Values

DYNAMIC_CALC_INT_VALUE

public static final int DYNAMIC_CALC_INT_VALUE

See Also:

Constant Field Values

EXTENDED_SHARED_MEMBER_INT_VALUE

public static final int EXTENDED_SHARED_MEMBER_INT_VALUE

See Also:

Constant Field Values

Constructor Detail

EEssShareOption

public EEssShareOption()

Method Detail

sm_fromString

public static IEssMember.EEssShareOption sm_fromString(java.lang.String strValue)
                                                throws com.essbase.api.base.EssException

Gets an enumeration object from its string display value.

Parameters:

strValue - The string display value.

Returns:

The enumeration object.

Throws:

com.essbase.api.base.EssException - if an error occurs.

sm_fromInt

public static IEssMember.EEssShareOption sm_fromInt(int intValue)
                                             throws com.essbase.api.base.EssException

Gets an enumeration object from its int value.

Parameters:

intValue - The int value.

Returns:

The enumeration object.

Throws:

com.essbase.api.base.EssException - if an error occurs.

sm_values

public static IEssMember.EEssShareOption[] sm_values()
                                              throws com.essbase.api.base.EssException

Gets all the enumeration objects.

Returns:

The enumeration objects.

Throws:

com.essbase.api.base.EssException - if an error occurs.

stringValue

public java.lang.String stringValue()
                             throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the String display value of the IEssEnum.

Specified by:

stringValue in interface IEssEnum

Returns:

The String display value of the IEssEnum.

Throws:

EssException - if an error occurs.

intValue

public int intValue()
             throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the int value of the IEssEnum.

Specified by:

intValue in interface IEssEnum

Returns:

The int value of the IEssEnum.

Throws:

EssException - if an error occurs.

fromInt

public IEssEnum fromInt(int intValue)
                 throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the IEssEnum from the int value.

Specified by:

fromInt in interface IEssEnum

Parameters:

intValue - The int value.

Returns:

The IEssEnum interface.

Throws:

EssException - if an error occurs.

fromString

public IEssEnum fromString(java.lang.String strValue)
                    throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the IEssEnum from the String display value.

Specified by:

fromString in interface IEssEnum

Parameters:

strValue - The String display value.

Returns:

The IEssEnum interface.

Throws:

EssException - if an error occurs.

getCountPossibleValues

public int getCountPossibleValues()
                           throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the count of possible values of the enumeration.

Specified by:

getCountPossibleValues in interface IEssEnum

Returns:

The count of possible values in the enumeration.

Throws:

EssException - if an error occurs.

getPossibleValues

public java.lang.String[] getPossibleValues()
                                     throws com.essbase.api.base.EssException

Description copied from interface: IEssEnum

Gets the list of possible values of the enumeration.

Specified by:

getPossibleValues in interface IEssEnum

Returns:

The list of possible values in the enumeration.

Throws:

EssException - if an error occurs.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object