Skip navigation links


com.essbase.api.datasource
Class IEssCube.EEssLoadStatus

java.lang.Object
  extended by com.essbase.api.datasource.IEssCube.EEssLoadStatus

All Implemented Interfaces:
IEssBaseObject, IEssEnum
Enclosing interface:
IEssCube

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

The EEssLoadStatus class is an enumeration of Cube load status.

Version:
1.0, 04/04/2002
Author:
Srini Ranga

Field Summary
static IEssCube.EEssLoadStatus LOADED
          Load status: Cube loaded.
static int LOADED_INT_VALUE
          Load status (int value): Cube loaded.
static IEssCube.EEssLoadStatus LOADING
          Load status: Cube loading.
static int LOADING_INT_VALUE
          Load status (int value): Cube loading.
static IEssCube.EEssLoadStatus NOT_LOADED
          Load status: Cube not loaded.
static int NOT_LOADED_INT_VALUE
          Load status (int value): Cube not loaded.
static IEssCube.EEssLoadStatus UNLOADING
          Load status: Cube is unloading.
static int UNLOADING_INT_VALUE
          Load status (int value): Cube is unloading.

 

Constructor Summary
IEssCube.EEssLoadStatus()
           

 

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

NOT_LOADED

public static final IEssCube.EEssLoadStatus NOT_LOADED
Load status: Cube not loaded.

LOADING

public static final IEssCube.EEssLoadStatus LOADING
Load status: Cube loading.

LOADED

public static final IEssCube.EEssLoadStatus LOADED
Load status: Cube loaded.

UNLOADING

public static final IEssCube.EEssLoadStatus UNLOADING
Load status: Cube is unloading.

NOT_LOADED_INT_VALUE

public static final int NOT_LOADED_INT_VALUE
Load status (int value): Cube not loaded.
See Also:
Constant Field Values

LOADING_INT_VALUE

public static final int LOADING_INT_VALUE
Load status (int value): Cube loading.
See Also:
Constant Field Values

LOADED_INT_VALUE

public static final int LOADED_INT_VALUE
Load status (int value): Cube loaded.
See Also:
Constant Field Values

UNLOADING_INT_VALUE

public static final int UNLOADING_INT_VALUE
Load status (int value): Cube is unloading.
See Also:
Constant Field Values

Constructor Detail

IEssCube.EEssLoadStatus

public IEssCube.EEssLoadStatus()

Method Detail

sm_fromString

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