public enum ScopeType extends java.lang.Enum<ScopeType>
getScope(RequestContext)
.
A "scope" defines a data structure for storing custom user attributes within a flow execution. Different scope types have different semantics in terms of how long attributes placed in those scope maps remain valid.
Enum Constant and Description |
---|
CONVERSATION
The "conversation" scope type.
|
FLASH
The "flash" scope type.
|
FLOW
The "flow" scope type.
|
REQUEST
The "request" scope type.
|
VIEW
The "view" scope type.
|
Modifier and Type | Method and Description |
---|---|
abstract MutableAttributeMap<java.lang.Object> |
getScope(RequestContext context)
Accessor that returns the mutable attribute map for this scope type for a given flow execution request context.
|
java.lang.Class<?> |
getType() |
static ScopeType |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static ScopeType[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final ScopeType REQUEST
public static final ScopeType FLASH
Flash scope is typically used to store messages that should be preserved until after the next view renders.
public static final ScopeType VIEW
View scope is typically used to store view model objects manipulated over a series of Ajax requests.
public static final ScopeType FLOW
flow definition
. When the flow session ends any data in
flow scope goes out of scope.public static final ScopeType CONVERSATION
public static ScopeType[] values()
for (ScopeType c : ScopeType.values()) System.out.println(c);
public static ScopeType valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic java.lang.Class<?> getType()
public abstract MutableAttributeMap<java.lang.Object> getScope(RequestContext context)
context
- the context representing an executing request