Skip navigation links


com.essbase.api.datasource
Class IEssCube.EEssRestructureOption

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

All Implemented Interfaces:
IEssBaseObject, IEssEnum
Enclosing interface:
IEssCube

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

The EEssRestructureOption class is an enumeration of Cube restructure options.

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

Field Summary
static IEssCube.EEssRestructureOption DISCARD_ALL_DATA
          Restructure option: Discard all data.
static int DISCARD_ALL_DATA_INT_VALUE
          Restructure option (int value): Discard all data.
static IEssCube.EEssRestructureOption KEEP_ALL_DATA
          Restructure option: Keep all data.
static int KEEP_ALL_DATA_INT_VALUE
          Restructure option (int value): Keep all data.
static IEssCube.EEssRestructureOption KEEP_ONLY_INPUT_DATA
          Restructure option: Keep only input data.
static int KEEP_ONLY_INPUT_DATA_INT_VALUE
          Restructure option (int value): Keep only input data.
static IEssCube.EEssRestructureOption KEEP_ONLY_LEVEL0_DATA
          Restructure option: Keep only level-0 data.
static int KEEP_ONLY_LEVEL0_DATA_INT_VALUE
          Restructure option (int value): Keep only level-0 data.

 

Constructor Summary
IEssCube.EEssRestructureOption()
           

 

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

KEEP_ALL_DATA

public static final IEssCube.EEssRestructureOption KEEP_ALL_DATA
Restructure option: Keep all data.

DISCARD_ALL_DATA

public static final IEssCube.EEssRestructureOption DISCARD_ALL_DATA
Restructure option: Discard all data.

KEEP_ONLY_LEVEL0_DATA

public static final IEssCube.EEssRestructureOption KEEP_ONLY_LEVEL0_DATA
Restructure option: Keep only level-0 data.

KEEP_ONLY_INPUT_DATA

public static final IEssCube.EEssRestructureOption KEEP_ONLY_INPUT_DATA
Restructure option: Keep only input data.

KEEP_ALL_DATA_INT_VALUE

public static final int KEEP_ALL_DATA_INT_VALUE
Restructure option (int value): Keep all data.
See Also:
Constant Field Values

DISCARD_ALL_DATA_INT_VALUE

public static final int DISCARD_ALL_DATA_INT_VALUE
Restructure option (int value): Discard all data.
See Also:
Constant Field Values

KEEP_ONLY_LEVEL0_DATA_INT_VALUE

public static final int KEEP_ONLY_LEVEL0_DATA_INT_VALUE
Restructure option (int value): Keep only level-0 data.
See Also:
Constant Field Values

KEEP_ONLY_INPUT_DATA_INT_VALUE

public static final int KEEP_ONLY_INPUT_DATA_INT_VALUE
Restructure option (int value): Keep only input data.
See Also:
Constant Field Values

Constructor Detail

IEssCube.EEssRestructureOption

public IEssCube.EEssRestructureOption()

Method Detail

sm_fromString

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