blackboard.platform.session
Enum UserDataService.Scope

java.lang.Object
  java.lang.Enum<UserDataService.Scope>
      blackboard.platform.session.UserDataService.Scope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UserDataService.Scope>

Enclosing interface:

UserDataService

public static enum UserDataService.Scope
extends java.lang.Enum<UserDataService.Scope>

The options for scopes to store the data in. If a given scope is unavailable, all methods called on that scope will throw a ScopeNotSupportedException exception. TEMPORARY scope is backed by the HttpSession. This means that the values will not be available from webapps that are not the one that set the value. PERMANENT scope is backed by the database. Care should be taken when using operations that access the permanent scope so that unnecessary database calls are not made. Permanent scope is write-on-set, so sets will be persisted to the database immediately.

Enum Constant Summary

PERMANENT

TEMPORARY

Method Summary

static UserDataService.Scope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UserDataService.Scope[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEMPORARY

public static final UserDataService.Scope TEMPORARY

PERMANENT

public static final UserDataService.Scope PERMANENT

Method Detail

values

public static final UserDataService.Scope[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(UserDataService.Scope c : UserDataService.Scope.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static UserDataService.Scope valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name