com.essbase.api.dataquery

Class IEssCubeView.EEssIndentStyle

java.lang.Object

com.essbase.api.dataquery.IEssCubeView.EEssIndentStyle

All Implemented Interfaces:

IEssBaseObject, IEssEnum

Enclosing interface:

IEssCubeView

public static final class IEssCubeView.EEssIndentStyle
extends java.lang.Object
implements IEssEnum

The EEssIndentStyle is an enumeration of indent styles.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

Field Summary

Fields

Modifier and Type	Field and Description
static IEssCubeView.EEssIndentStyle	NONE Indent style: None.
static int	NONE_INT_VALUE Indent style (int value): None.
static IEssCubeView.EEssIndentStyle	SUB_ITEMS Indent style: Sub Items.
static int	SUB_ITEMS_INT_VALUE Indent style (int value): Sub Items.
static IEssCubeView.EEssIndentStyle	TOTALS Indent style: Totals.
static int	TOTALS_INT_VALUE Indent style (int value): Totals.

Constructor Summary

Constructors

Constructor and Description
EEssIndentStyle()

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

Indent style: None.

SUB_ITEMS

public static final IEssCubeView.EEssIndentStyle SUB_ITEMS

Indent style: Sub Items.

TOTALS

public static final IEssCubeView.EEssIndentStyle TOTALS

Indent style: Totals.

NONE_INT_VALUE

public static final int NONE_INT_VALUE

Indent style (int value): None.

See Also:

Constant Field Values

SUB_ITEMS_INT_VALUE

public static final int SUB_ITEMS_INT_VALUE

Indent style (int value): Sub Items.

See Also:

Constant Field Values

TOTALS_INT_VALUE

public static final int TOTALS_INT_VALUE

Indent style (int value): Totals.

See Also:

Constant Field Values

Constructor Detail

EEssIndentStyle

public EEssIndentStyle()

Method Detail

sm_fromString

public static IEssCubeView.EEssIndentStyle 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 IEssCubeView.EEssIndentStyle 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 IEssCubeView.EEssIndentStyle[] 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