com.businessobjects.rebean.wi
Class ScopeLevel

java.lang.Object
  com.businessobjects.rebean.wi.ScopeLevel

public final class ScopeLevel
extends java.lang.Object

Warning: This class is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Represents all possible scope levels.

See Also:

Scope

Field Summary

static int	_CUSTOM int value of CUSTOM.value()
static int	_LEVEL_1 int value of LEVEL_1.value()
static int	_LEVEL_2 int value of LEVEL_2.value()
static int	_LEVEL_3 int value of LEVEL_3.value()
static ScopeLevel	CUSTOM Defines a custom scope level.
static ScopeLevel	LEVEL_1 Defines scope level 1.
static ScopeLevel	LEVEL_2 Defines scope level 2.
static ScopeLevel	LEVEL_3 Defines scope level 3.

Method Summary

static ScopeLevel	fromInt(int value) Reurns a ScopeLevel instance corresponding to value, or null when value does not correspond to any ScopeLevel
java.lang.String	toString() Returns a String representation of this scope level (for debug purposes)
int	value() Returns the int value of this scope level

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_LEVEL_1

public static final int _LEVEL_1

int value of LEVEL_1.value()

See Also:

Constant Field Values

_LEVEL_2

public static final int _LEVEL_2

int value of LEVEL_2.value()

See Also:

Constant Field Values

_LEVEL_3

public static final int _LEVEL_3

int value of LEVEL_3.value()

See Also:

Constant Field Values

_CUSTOM

public static final int _CUSTOM

int value of CUSTOM.value()

See Also:

Constant Field Values

LEVEL_1

public static final ScopeLevel LEVEL_1

Defines scope level 1. When scope level is LEVEL_1, the scope of analysis is such that for each object in the query, the user can drill down once without having to change the query; the data is already in the query.

LEVEL_2

public static final ScopeLevel LEVEL_2

Defines scope level 2. When scope level is LEVEL_2, the scope of analysis is such that for each object in the query, the user can drill down twice without having to change the query; the data is already in the query.

LEVEL_3

public static final ScopeLevel LEVEL_3

Defines scope level 3. When scope level is LEVEL_3, the scope of analysis is such that for each object in the query, the user can drill down three levels without having to change the query; the data is already in the query.

CUSTOM

public static final ScopeLevel CUSTOM

Defines a custom scope level. The scope level is CUSTOM whenever the rules of LEVEL_1, LEVEL_2 or LEVEL_3 don't apply. Note that this means that when there are no objects in the scope of analysis, the level is CUSTUM.

Method Detail

value

public int value()

Returns the int value of this scope level

Returns:

the int value of this scope level

toString

public java.lang.String toString()

Returns a String representation of this scope level (for debug purposes)

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this scope level (for debug purposes)

fromInt

public static ScopeLevel fromInt(int value)

Reurns a ScopeLevel instance corresponding to value, or null when value does not correspond to any ScopeLevel

Returns:

a ScopeLevel instance corresponding to value, or null when value does not correspond to any ScopeLevel