com.essbase.api.metadata

Class IEssCubeOutline.EEssAliasTableOption

java.lang.Object

com.essbase.api.metadata.IEssCubeOutline.EEssAliasTableOption

All Implemented Interfaces:

IEssBaseObject, IEssEnum

Enclosing interface:

IEssCubeOutline

public static final class IEssCubeOutline.EEssAliasTableOption
extends java.lang.Object
implements IEssEnum

EEssAliasTableOption class is the alias table option type. This is usually used while creating an alias table.

Version:

1.0, 2005-3-29

Author:

Balaji S

Field Summary

Fields

Modifier and Type	Field and Description
static IEssCubeOutline.EEssAliasTableOption	DEFAULT TODO: ???
static int	DEFAULT_INT_VALUE
static IEssCubeOutline.EEssAliasTableOption	NONUNIQUE_ALIAS
static int	NONUNIQUE_ALIAS_INT_VALUE
static IEssCubeOutline.EEssAliasTableOption	UNIQUEALIAS TODO: ???
static int	UNIQUEALIAS_INT_VALUE
static IEssCubeOutline.EEssAliasTableOption	UNIQUENAME TODO: ???
static int	UNIQUENAME_INT_VALUE

Constructor Summary

Constructors

Constructor and Description
EEssAliasTableOption()

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

DEFAULT

public static final IEssCubeOutline.EEssAliasTableOption DEFAULT

TODO: ???

UNIQUEALIAS

public static final IEssCubeOutline.EEssAliasTableOption UNIQUEALIAS

TODO: ???

UNIQUENAME

public static final IEssCubeOutline.EEssAliasTableOption UNIQUENAME

TODO: ???

NONUNIQUE_ALIAS

public static final IEssCubeOutline.EEssAliasTableOption NONUNIQUE_ALIAS

DEFAULT_INT_VALUE

public static final int DEFAULT_INT_VALUE

See Also:

Constant Field Values

UNIQUEALIAS_INT_VALUE

public static final int UNIQUEALIAS_INT_VALUE

See Also:

Constant Field Values

UNIQUENAME_INT_VALUE

public static final int UNIQUENAME_INT_VALUE

See Also:

Constant Field Values

NONUNIQUE_ALIAS_INT_VALUE

public static final int NONUNIQUE_ALIAS_INT_VALUE

See Also:

Constant Field Values

Constructor Detail

EEssAliasTableOption

public EEssAliasTableOption()

Method Detail

sm_fromString

public static IEssCubeOutline.EEssAliasTableOption 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 IEssCubeOutline.EEssAliasTableOption 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 IEssCubeOutline.EEssAliasTableOption[] 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