com.essbase.api.datasource

Class IEssCube.EEssCubeAccess

java.lang.Object

com.essbase.api.datasource.IEssCube.EEssCubeAccess

All Implemented Interfaces:

IEssBaseObject, IEssEnum

Enclosing interface:

IEssCube

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

The EEssCubeAccess is an enumeration of cube access levels.

Version:

1.0, 04/04/2002

Author:

Srini Ranga

Field Summary

Fields

Modifier and Type	Field and Description
static IEssCube.EEssCubeAccess	CALCULATE_CUBE_DATA Cube access: Calculate cube data.
static int	CALCULATE_CUBE_DATA_INT_VALUE Cube access (int value): Calculate cube data.
static IEssCube.EEssCubeAccess	DESIGN_CUBE Cube access: Design cube.
static int	DESIGN_CUBE_INT_VALUE Cube access (int value): Design cube.
static IEssCube.EEssCubeAccess	FILTER_ACCESS Cube access: Filter access.
static int	FILTER_ACCESS_INT_VALUE Cube access (int value): Filter access.
static IEssCube.EEssCubeAccess	NONE Cube access: None.
static int	NONE_INT_VALUE Cube access (int value): None.
static IEssCube.EEssCubeAccess	READ_CUBE_DATA Cube access: Read cube data.
static int	READ_CUBE_DATA_INT_VALUE Cube access (int value): Read cube data.
static IEssCube.EEssCubeAccess	READ_WRITE_CUBE_DATA Cube access: Read/Write cube data.
static int	READ_WRITE_CUBE_DATA_INT_VALUE Cube access (int value): Read/Write cube data.

Constructor Summary

Constructors

Constructor and Description
EEssCubeAccess()

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

Cube access: None.

FILTER_ACCESS

public static final IEssCube.EEssCubeAccess FILTER_ACCESS

Cube access: Filter access. (can be used only for user/group level security, and cannot to be used for app's min cube access and cube's default access)

READ_CUBE_DATA

public static final IEssCube.EEssCubeAccess READ_CUBE_DATA

Cube access: Read cube data.

READ_WRITE_CUBE_DATA

public static final IEssCube.EEssCubeAccess READ_WRITE_CUBE_DATA

Cube access: Read/Write cube data.

CALCULATE_CUBE_DATA

public static final IEssCube.EEssCubeAccess CALCULATE_CUBE_DATA

Cube access: Calculate cube data.

DESIGN_CUBE

public static final IEssCube.EEssCubeAccess DESIGN_CUBE

Cube access: Design cube.

NONE_INT_VALUE

public static final int NONE_INT_VALUE

Cube access (int value): None.

See Also:

Constant Field Values

FILTER_ACCESS_INT_VALUE

public static final int FILTER_ACCESS_INT_VALUE

Cube access (int value): Filter access. (can be used only for user/ group level security, and cannot to be used for app's min cube access and cube's default access)

See Also:

Constant Field Values

READ_CUBE_DATA_INT_VALUE

public static final int READ_CUBE_DATA_INT_VALUE

Cube access (int value): Read cube data.

See Also:

Constant Field Values

READ_WRITE_CUBE_DATA_INT_VALUE

public static final int READ_WRITE_CUBE_DATA_INT_VALUE

Cube access (int value): Read/Write cube data.

See Also:

Constant Field Values

CALCULATE_CUBE_DATA_INT_VALUE

public static final int CALCULATE_CUBE_DATA_INT_VALUE

Cube access (int value): Calculate cube data.

See Also:

Constant Field Values

DESIGN_CUBE_INT_VALUE

public static final int DESIGN_CUBE_INT_VALUE

Cube access (int value): Design cube.

See Also:

Constant Field Values

Constructor Detail

EEssCubeAccess

public EEssCubeAccess()

Method Detail

sm_fromString

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