org.pentaho.platform.api.engine
Enum IPentahoDefinableObjectFactory.Scope

java.lang.Object
  extended by java.lang.Enum<IPentahoDefinableObjectFactory.Scope>
      extended by org.pentaho.platform.api.engine.IPentahoDefinableObjectFactory.Scope
All Implemented Interfaces:
Serializable, Comparable<IPentahoDefinableObjectFactory.Scope>
Enclosing interface:
IPentahoDefinableObjectFactory

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

The different object scopes that are supported

Author:
jamesdixon

Enum Constant Summary
GLOBAL
           
LOCAL
           
REQUEST
           
SESSION
           
THREAD
           
 
Method Summary
static IPentahoDefinableObjectFactory.Scope valueOf(String name)
          Returns the enum constant of this type with the specified name.
static IPentahoDefinableObjectFactory.Scope[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

GLOBAL

public static final IPentahoDefinableObjectFactory.Scope GLOBAL

SESSION

public static final IPentahoDefinableObjectFactory.Scope SESSION

REQUEST

public static final IPentahoDefinableObjectFactory.Scope REQUEST

THREAD

public static final IPentahoDefinableObjectFactory.Scope THREAD

LOCAL

public static final IPentahoDefinableObjectFactory.Scope LOCAL
Method Detail

values

public static IPentahoDefinableObjectFactory.Scope[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (IPentahoDefinableObjectFactory.Scope c : IPentahoDefinableObjectFactory.Scope.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static IPentahoDefinableObjectFactory.Scope valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
NullPointerException - if the argument is null