Skip navigation links

com.essbase.api.metadata
Class IEssDimension.EEssDimensionCategory

java.lang.Object
com.essbase.api.metadata.IEssDimension.EEssDimensionCategory

All Implemented Interfaces:

IEssBaseObject, IEssEnum

Enclosing interface:

IEssDimension

public static final class IEssDimension.EEssDimensionCategory

extends java.lang.Object

implements IEssEnum

EEssDimensionCategory class is the dimension category. This is valid only for dimensions and attribute members.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Field Summary

static IEssDimension.EEssDimensionCategory	ACCOUNTS
static int	ACCOUNTS_INT_VALUE
static IEssDimension.EEssDimensionCategory	ATTRIBUTE
static IEssDimension.EEssDimensionCategory	ATTRIBUTE_CALC
static int	ATTRIBUTE_CALC_INT_VALUE
static int	ATTRIBUTE_INT_VALUE
static IEssDimension.EEssDimensionCategory	COUNTRY
static int	COUNTRY_INT_VALUE
static IEssDimension.EEssDimensionCategory	CURRENCY_PARTITION
static int	CURRENCY_PARTITION_INT_VALUE
static IEssDimension.EEssDimensionCategory	NONE
static int	NONE_INT_VALUE
static IEssDimension.EEssDimensionCategory	TIME
static int	TIME_INT_VALUE
static IEssDimension.EEssDimensionCategory	TYPE
static int	TYPE_INT_VALUE

Constructor Summary

IEssDimension.EEssDimensionCategory()

Method Summary

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 IEssDimension.EEssDimensionCategory	sm_fromInt(int intValue) Gets an enumeration object from its int value.
static IEssDimension.EEssDimensionCategory	sm_fromString(java.lang.String strValue) Gets an enumeration object from its string display value.
static IEssDimension.EEssDimensionCategory[]	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

NONE

public static final IEssDimension.EEssDimensionCategory NONE

ACCOUNTS

public static final IEssDimension.EEssDimensionCategory ACCOUNTS

TIME

public static final IEssDimension.EEssDimensionCategory TIME

COUNTRY

public static final IEssDimension.EEssDimensionCategory COUNTRY

TYPE

public static final IEssDimension.EEssDimensionCategory TYPE

CURRENCY_PARTITION

public static final IEssDimension.EEssDimensionCategory CURRENCY_PARTITION

ATTRIBUTE

public static final IEssDimension.EEssDimensionCategory ATTRIBUTE

ATTRIBUTE_CALC

public static final IEssDimension.EEssDimensionCategory ATTRIBUTE_CALC

NONE_INT_VALUE

public static final int NONE_INT_VALUE

See Also:

Constant Field Values

ACCOUNTS_INT_VALUE

public static final int ACCOUNTS_INT_VALUE

See Also:

Constant Field Values

TIME_INT_VALUE

public static final int TIME_INT_VALUE

See Also:

Constant Field Values

COUNTRY_INT_VALUE

public static final int COUNTRY_INT_VALUE

See Also:

Constant Field Values

TYPE_INT_VALUE

public static final int TYPE_INT_VALUE

See Also:

Constant Field Values

CURRENCY_PARTITION_INT_VALUE

public static final int CURRENCY_PARTITION_INT_VALUE

See Also:

Constant Field Values

ATTRIBUTE_INT_VALUE

public static final int ATTRIBUTE_INT_VALUE

See Also:

Constant Field Values

ATTRIBUTE_CALC_INT_VALUE

public static final int ATTRIBUTE_CALC_INT_VALUE

See Also:

Constant Field Values

Constructor Detail

IEssDimension.EEssDimensionCategory

public IEssDimension.EEssDimensionCategory()

Method Detail

sm_fromString

public static IEssDimension.EEssDimensionCategory 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 IEssDimension.EEssDimensionCategory 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 IEssDimension.EEssDimensionCategory[] 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

Skip navigation links