org.springframework.webflow.execution: abstract public class: ScopeType

org.springframework.webflow.execution
abstract public class: ScopeType [javadoc | source]

java.lang.Object
   org.springframework.core.enums.StaticLabeledEnum
      org.springframework.webflow.execution.ScopeType

An enumeration of the core scope types of Spring Web Flow. Provides easy access to each scope by type using #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.

author: Keith - Donald

author: Erwin - Vervaet

Field Summary
public static final ScopeType	REQUEST	The "request" scope type. Attributes placed in request scope exist for the life of the current request into the flow execution. When the request ends any attributes in request scope go out of scope.
public static final ScopeType	FLASH	The "flash" scope type. Attributes placed in flash scope exist through the life of the current request and until the next view rendering. After the view renders, flash scope is cleared. Flash scope is typically used to store messages that should be preserved until after the next view renders.
public static final ScopeType	VIEW	The "view" scope type. Attributes placed in view scope exist through the life of the current view state and until the view state exits in a subsequent request. View scope is typically used to store view model objects manipulated over a series of Ajax requests.
public static final ScopeType	FLOW	The "flow" scope type. Attributes placed in flow scope exist through the life of an executing flow session, representing an instance a single flow definition . When the flow session ends any data in flow scope goes out of scope.
public static final ScopeType	CONVERSATION	The "conversation" scope type. Attributes placed in conversation scope are shared by all flow sessions started within a flow execution and live for the life of the entire flow execution (representing a single logical user conversation). When the governing execution ends, any data in conversation scope goes out of scope.

Method from org.springframework.webflow.execution.ScopeType Summary:
getScope, getType

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.springframework.webflow.execution.ScopeType Detail:
abstract public MutableAttributeMap getScope(RequestContext context) Accessor that returns the mutable attribute map for this scope type for a given flow execution request context.
public Class getType() { // force ScopeType as type return ScopeType.class; }

Method from org.springframework.webflow.execution.ScopeType Detail:

 abstract public MutableAttributeMap getScope(RequestContext context)Accessor that returns the mutable attribute map for this scope type for a given flow execution request context.

 public Class getType() {
		// force ScopeType as type
		return ScopeType.class;
}