com.essbase.api.datasource

Class IEssCube.EEssImpliedShare

java.lang.Object

com.essbase.api.datasource.IEssCube.EEssImpliedShare

All Implemented Interfaces:

IEssBaseObject, IEssEnum

Enclosing interface:

IEssCube

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

Field Summary

Fields

Modifier and Type	Field and Description
static IEssCube.EEssImpliedShare	ESS_IMPLIEDSHARE_DEFAULT Can be set using setImpliedShare, immediately gets converted to either _ON or _OFF
static int	ESS_IMPLIEDSHARE_DEFAULT_INT_VALUE
static IEssCube.EEssImpliedShare	ESS_IMPLIEDSHARE_DEFAULT_OFF Return value only available using getImpliedShare.
static int	ESS_IMPLIEDSHARE_DEFAULT_OFF_INT_VALUE
static IEssCube.EEssImpliedShare	ESS_IMPLIEDSHARE_DEFAULT_ON Return value only available using getImpliedShare.
static int	ESS_IMPLIEDSHARE_DEFAULT_ON_INT_VALUE
static IEssCube.EEssImpliedShare	ESS_IMPLIEDSHARE_FORCE_OFF Can be set using setImpliedShare.
static int	ESS_IMPLIEDSHARE_FORCE_OFF_INT_VALUE
static IEssCube.EEssImpliedShare	ESS_IMPLIEDSHARE_FORCE_ON Can be set using setImpliedShare.
static int	ESS_IMPLIEDSHARE_FORCE_ON_INT_VALUE

Constructor Summary

Constructors

Constructor and Description
EEssImpliedShare()

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

ESS_IMPLIEDSHARE_DEFAULT

public static final IEssCube.EEssImpliedShare ESS_IMPLIEDSHARE_DEFAULT

Can be set using setImpliedShare, immediately gets converted to either _ON or _OFF

ESS_IMPLIEDSHARE_DEFAULT_ON

public static final IEssCube.EEssImpliedShare ESS_IMPLIEDSHARE_DEFAULT_ON

Return value only available using getImpliedShare. - Outline uses Implied Share default setting in Essbase.cfg - Essbase.cfg might contain an Implied Share entry (ON) - Essbase.cfg should contain no entry - Implied Share is ON

ESS_IMPLIEDSHARE_DEFAULT_OFF

public static final IEssCube.EEssImpliedShare ESS_IMPLIEDSHARE_DEFAULT_OFF

Return value only available using getImpliedShare. - Outline uses Implied Share default setting in Essbase.cfg - Essbase.cfg contains an Implied Share entry (OFF) - Implied Share is OFF

ESS_IMPLIEDSHARE_FORCE_ON

public static final IEssCube.EEssImpliedShare ESS_IMPLIEDSHARE_FORCE_ON

Can be set using setImpliedShare. An explicit setting indicating the outline always has Implied Share ON.

ESS_IMPLIEDSHARE_FORCE_OFF

public static final IEssCube.EEssImpliedShare ESS_IMPLIEDSHARE_FORCE_OFF

Can be set using setImpliedShare. An explicit setting indicating the outline always has Implied Share OFF.

ESS_IMPLIEDSHARE_DEFAULT_INT_VALUE

public static final int ESS_IMPLIEDSHARE_DEFAULT_INT_VALUE

See Also:

Constant Field Values

ESS_IMPLIEDSHARE_DEFAULT_ON_INT_VALUE

public static final int ESS_IMPLIEDSHARE_DEFAULT_ON_INT_VALUE

See Also:

Constant Field Values

ESS_IMPLIEDSHARE_DEFAULT_OFF_INT_VALUE

public static final int ESS_IMPLIEDSHARE_DEFAULT_OFF_INT_VALUE

See Also:

Constant Field Values

ESS_IMPLIEDSHARE_FORCE_ON_INT_VALUE

public static final int ESS_IMPLIEDSHARE_FORCE_ON_INT_VALUE

See Also:

Constant Field Values

ESS_IMPLIEDSHARE_FORCE_OFF_INT_VALUE

public static final int ESS_IMPLIEDSHARE_FORCE_OFF_INT_VALUE

See Also:

Constant Field Values

Constructor Detail

EEssImpliedShare

public EEssImpliedShare()

Method Detail

sm_fromString

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