Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.essbase.api.base
Interface IEssEnum

All Superinterfaces:
  IEssBaseObject

All Known Implementing Classes:
  IEssAppComponent.EEssAppComponentType, IEssbase.EEssAuthenticatorType, IEssbase.EEssOrbPluginType, IEssCell.EEssCellType, IEssCluster.EEssClusterType, IEssCluster.EEssLoadBalanceAlgorithm, IEssConnectionPool.EEssConnectionPoolType, IEssCube.EEssCubeAccess, IEssCube.EEssCubeType, IEssCube.EEssCurrencyConversionType, IEssCube.EEssDataLevel, IEssCube.EEssDataLoadStatus, IEssCube.EEssLoadStatus, IEssCube.EEssRestructureOption, IEssCubeView.EEssIndentStyle, IEssCubeView.EEssQueryGrammar, IEssDataCell.EEssAccessMode, IEssDataCell.EEssDataCellType, IEssDimension.EEssAttributeDataType, IEssDimension.EEssDimensionCategory, IEssDimension.EEssDimensionStorageCategory, IEssDimension.EEssDimensionStorageType, IEssDimension.EEssDimensionTag, IEssDomain.EEssDomainObjectType, IEssLinkedObject.EEssLinkedObjectType, IEssMember.EEssConsolidationType, IEssMember.EEssCurrencyConversionType, IEssMember.EEssShareOption, IEssMember.EEssTimeBalanceOption, IEssMember.EEssTimeBalanceSkipOption, IEssOlapApplication.EEssLoadStatus, IEssOlapApplication.EEssOlapApplicationAccess, IEssOperation.EEssOperationType, IEssOpMdxQuery.EEssMemberIdentifierType, IEssOpZoomIn.EEssZoomInPreference, IEssProperties.EEssPropertyMode, IEssServer.EEssServerType, IEssValueAny.EEssDataType

public interface IEssEnum
extends IEssBaseObject

The IEssEnum interface.

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.
`java.lang.String` | `stringValue()` Gets the String display value of the IEssEnum.

Method Detail

### intValue

    public int intValue()
                 throws EssException

  Gets the int value of the IEssEnum.

  Returns:
    The int value of the IEssEnum.
  Throws:
    `EssException` - if an error occurs.

### stringValue

    public java.lang.String stringValue()
                                 throws EssException

  Gets the String display value of the IEssEnum.

  Returns:
    The String display value of the IEssEnum.
  Throws:
    `EssException` - if an error occurs.

### fromInt

    public IEssEnum fromInt(int intValue)
                     throws EssException

  Gets the IEssEnum from the int value.

  Returns:
    The IEssEnum interface.
  Throws:
    `EssException` - if an error occurs.

### fromString

    public IEssEnum fromString(java.lang.String strValue)
                        throws EssException

  Gets the IEssEnum from the String display value.

  Returns:
    The IEssEnum interface.
  Throws:
    `EssException` - if an error occurs.

### getCountPossibleValues

    public int getCountPossibleValues()
                               throws EssException

  Gets the count of possible values of the enumeration.

  Returns:
    The count of possible values in the enumeration.
  Throws:
    `EssException` - if an error occurs.

### getPossibleValues

    public java.lang.String[] getPossibleValues()
                                         throws EssException

  Gets the list of possible values of the enumeration.

  Returns:
    The list of possible values in the enumeration.
  Throws:
    `EssException` - if an error occurs.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD