com.essbase.api.datasource

Class IEssCube.EEssDataLoadStatus

java.lang.Object

com.essbase.api.datasource.IEssCube.EEssDataLoadStatus

All Implemented Interfaces:

IEssBaseObject, IEssEnum

Enclosing interface:

IEssCube

public static final class IEssCube.EEssDataLoadStatus
extends java.lang.Object
implements IEssEnum

The EEssDataLoadStatus class.

Version:

1.0, 04/04/2002

Author:

Srini Ranga

Field Summary

Fields

Modifier and Type	Field and Description
static IEssCube.EEssDataLoadStatus	CLEAN Data load status: Data loaded and calculated.
static int	CLEAN_INT_VALUE Data load status (int value): Data loaded and calculated.
static IEssCube.EEssDataLoadStatus	LOAD_ON_CALC Data load status: Data loaded but not calculated.
static int	LOAD_ON_CALC_INT_VALUE Data load status (int value): Data loaded but not calculated.
static IEssCube.EEssDataLoadStatus	NONE Data load status: No data loaded
static int	NONE_INT_VALUE Data load status (int value): No data loaded

Constructor Summary

Constructors

Constructor and Description
EEssDataLoadStatus()

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

Data load status: No data loaded

LOAD_ON_CALC

public static final IEssCube.EEssDataLoadStatus LOAD_ON_CALC

Data load status: Data loaded but not calculated.

CLEAN

public static final IEssCube.EEssDataLoadStatus CLEAN

Data load status: Data loaded and calculated.

NONE_INT_VALUE

public static final int NONE_INT_VALUE

Data load status (int value): No data loaded

See Also:

Constant Field Values

LOAD_ON_CALC_INT_VALUE

public static final int LOAD_ON_CALC_INT_VALUE

Data load status (int value): Data loaded but not calculated.

See Also:

Constant Field Values

CLEAN_INT_VALUE

public static final int CLEAN_INT_VALUE

Data load status (int value): Data loaded and calculated.

See Also:

Constant Field Values

Constructor Detail

EEssDataLoadStatus

public EEssDataLoadStatus()

Method Detail

sm_fromString

public static IEssCube.EEssDataLoadStatus 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 IEssCube.EEssDataLoadStatus 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 IEssCube.EEssDataLoadStatus[] 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