Skip navigation links


com.essbase.api.datasource
Class IEssCube.EEssDataLevel

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

All Implemented Interfaces:
IEssBaseObject, IEssEnum
Enclosing interface:
IEssCube

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

The EEssDataLevel class is an enumeration of data level on export.

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

Field Summary
static IEssCube.EEssDataLevel ALL
          Data level on export: All the data.
static int ALL_INT_VALUE
          Data level on export (int value): All the data.
static IEssCube.EEssDataLevel INPUT
          Data level on export: Blocks marked as input blocks.
static int INPUT_INT_VALUE
          Data level on export (int value): Blocks marked as input blocks.
static IEssCube.EEssDataLevel LEVEL0
          Data level on export: Blocks with level 0 data.
static int LEVEL0_INT_VALUE
          Data level on export (int value): Blocks with level 0 data.

 

Constructor Summary
IEssCube.EEssDataLevel()
           

 

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

ALL

public static final IEssCube.EEssDataLevel ALL
Data level on export: All the data.

LEVEL0

public static final IEssCube.EEssDataLevel LEVEL0
Data level on export: Blocks with level 0 data.

INPUT

public static final IEssCube.EEssDataLevel INPUT
Data level on export: Blocks marked as input blocks.

ALL_INT_VALUE

public static int ALL_INT_VALUE
Data level on export (int value): All the data.

LEVEL0_INT_VALUE

public static int LEVEL0_INT_VALUE
Data level on export (int value): Blocks with level 0 data.

INPUT_INT_VALUE

public static int INPUT_INT_VALUE
Data level on export (int value): Blocks marked as input blocks.

Constructor Detail

IEssCube.EEssDataLevel

public IEssCube.EEssDataLevel()

Method Detail

sm_fromString

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