Package com.appliedolap.essbase

Enum Class EssVariable.Scope

java.lang.Object

java.lang.Enum<EssVariable.Scope>

com.appliedolap.essbase.EssVariable.Scope

All Implemented Interfaces:

Serializable, Comparable<EssVariable.Scope>, Constable

Enclosing interface:

EssVariable

public static enum EssVariable.Scope
extends Enum<EssVariable.Scope>

Which level a variable is defined at, in cascade order - each shadows the ones before it.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLICATION
CUBE
SERVER

Method Summary

Modifier and Type	Method	Description
String	getLabel()
boolean	shadows(EssVariable.Scope other)	Whether a variable at this scope takes precedence over one at the given scope.
static EssVariable.Scope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EssVariable.Scope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SERVER

public static final EssVariable.Scope SERVER

APPLICATION

public static final EssVariable.Scope APPLICATION

CUBE

public static final EssVariable.Scope CUBE

Method Details

values

public static EssVariable.Scope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static EssVariable.Scope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getLabel

public String getLabel()

shadows

public boolean shadows(EssVariable.Scope other)

Whether a variable at this scope takes precedence over one at the given scope. Cube beats application beats server, which is the order the constants are declared in.

Parameters:

other - the scope to compare against

Returns:

true if this scope wins