com.essbase.api.metadata

Class IEssMember.EEssTimeBalanceSkipOption

java.lang.Object

com.essbase.api.metadata.IEssMember.EEssTimeBalanceSkipOption

All Implemented Interfaces:

IEssBaseObject, IEssEnum

Enclosing interface:

IEssMember

public static final class IEssMember.EEssTimeBalanceSkipOption
extends java.lang.Object
implements IEssEnum

EEssTimeBalanceSkipOption class is the time balance skip option. This is valid only for members of the Accounts dimension, if time balance option (EEssTimeBalanceOption) is not equal to NONE.

Version:

1.0, 09/01/2000

Author:

Srini Ranga

Field Summary

Fields

Modifier and Type	Field and Description
static IEssMember.EEssTimeBalanceSkipOption	MISSING
static IEssMember.EEssTimeBalanceSkipOption	MISSING_AND_ZEROS
static int	MISSING_AND_ZEROS_INT_VALUE
static int	MISSING_INT_VALUE
static IEssMember.EEssTimeBalanceSkipOption	NONE
static int	NONE_INT_VALUE
static IEssMember.EEssTimeBalanceSkipOption	ZEROS
static int	ZEROS_INT_VALUE

Constructor Summary

Constructors

Constructor and Description
EEssTimeBalanceSkipOption()

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

NONE

public static final IEssMember.EEssTimeBalanceSkipOption NONE

MISSING

public static final IEssMember.EEssTimeBalanceSkipOption MISSING

ZEROS

public static final IEssMember.EEssTimeBalanceSkipOption ZEROS

MISSING_AND_ZEROS

public static final IEssMember.EEssTimeBalanceSkipOption MISSING_AND_ZEROS

NONE_INT_VALUE

public static final int NONE_INT_VALUE

See Also:

Constant Field Values

MISSING_INT_VALUE

public static final int MISSING_INT_VALUE

See Also:

Constant Field Values

ZEROS_INT_VALUE

public static final int ZEROS_INT_VALUE

See Also:

Constant Field Values

MISSING_AND_ZEROS_INT_VALUE

public static final int MISSING_AND_ZEROS_INT_VALUE

See Also:

Constant Field Values

Constructor Detail

EEssTimeBalanceSkipOption

public EEssTimeBalanceSkipOption()

Method Detail

sm_fromString

public static IEssMember.EEssTimeBalanceSkipOption 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 IEssMember.EEssTimeBalanceSkipOption 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 IEssMember.EEssTimeBalanceSkipOption[] 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