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.EEssCubeletType, IEssCube.EEssCubeType, IEssCube.EEssCurrencyConversionType, IEssCube.EEssDataLevel, IEssCube.EEssDataLoadStatus, IEssCube.EEssImpliedShare, IEssCube.EEssLoadStatus, IEssCube.EEssRestructureOption, IEssCube.EEssTimePeriod, IEssCubeOutline.EEssAliasTableOption, 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.EEssHierarchyType, IEssMember.EEssShareOption, IEssMember.EEssTimeBalanceOption, IEssMember.EEssTimeBalanceSkipOption, IEssOlapApplication.EEssDataStorageType, IEssOlapApplication.EEssLoadStatus, IEssOlapApplication.EEssOlapApplicationAccess, IEssOlapUser.EEssAccess, IEssOperation.EEssOperationType, IEssOpMdxQuery.EEssMemberIdentifierType, IEssOpZoomIn.EEssZoomInPreference, IEssProperties.EEssPropertyMode, IEssPropertyDefinition.EEssSystemPropertyTags, IEssServer.EEssServerType, IEssValueAny.EEssDataType

public interface IEssEnum
extends IEssBaseObject

The IEssEnum interface.

Version:

1.0, 04/04/2001

Author:

Srini Ranga

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

Method Detail

intValue

int intValue()
      throws com.essbase.api.base.EssException

Gets the int value of the IEssEnum.

Returns:

The int value of the IEssEnum.

Throws:

EssException - if an error occurs.

stringValue

java.lang.String stringValue()
                      throws com.essbase.api.base.EssException

Gets the String display value of the IEssEnum.

Returns:

The String display value of the IEssEnum.

Throws:

EssException - if an error occurs.

fromInt

IEssEnum fromInt(int intValue)
          throws com.essbase.api.base.EssException

Gets the IEssEnum from the int value.

Parameters:

intValue - The int value.

Returns:

The IEssEnum interface.

Throws:

EssException - if an error occurs.

fromString

IEssEnum fromString(java.lang.String strValue)
             throws com.essbase.api.base.EssException

Gets the IEssEnum from the String display value.

Parameters:

strValue - The String display value.

Returns:

The IEssEnum interface.

Throws:

EssException - if an error occurs.

getCountPossibleValues

int getCountPossibleValues()
                    throws com.essbase.api.base.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

java.lang.String[] getPossibleValues()
                              throws com.essbase.api.base.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.