| org.springframework.webflow.engine.RequestControlContext
All known Subclasses: org.springframework.webflow.engine.impl.RequestControlContextImpl, org.springframework.webflow.test.MockRequestControlContext,
| RequestControlContext | | public interface RequestControlContext extends RequestContext(Code) | | Mutable control interface used to manipulate an ongoing flow execution in the
context of one client request. Primarily used internally by the various flow
artifacts when they are invoked.
This interface acts as a facade for core definition constructs such as the
central Flow and State classes, abstracting
away details about the runtime execution machine defined in the
org.springframework.webflow.engine.impl execution engine implementation package.
Note this type is not the same as the
FlowExecutionContext . Objects
of this type are request specific: they provide a control interface
for manipulating exactly one flow execution locally from exactly one request.
A FlowExecutionContext provides information about a single
flow execution (conversation), and it's scope is not local to a specific
request (or thread).
See Also: org.springframework.webflow.engine.Flow
See Also: org.springframework.webflow.engine.State
See Also: org.springframework.webflow.execution.FlowExecution
See Also: FlowExecutionContext
author:
Keith Donald
author:
Erwin Vervaet |
| setCurrentState | | public void setCurrentState(State state)(Code) | | Record the current state that has entered in the executing flow. This
method will be called as part of entering a new state by the State type
itself.
Parameters:
state - the current state
See Also: State.enter(RequestControlContext) |
| setLastEvent | | public void setLastEvent(Event lastEvent)(Code) | | Record the last event signaled in the executing flow. This method will be
called as part of signaling an event in a flow to indicate the
'lastEvent' that was signaled.
Parameters:
lastEvent - the last event signaled
See Also: Flow.onEvent(RequestControlContext) |
| setLastTransition | | public void setLastTransition(Transition lastTransition)(Code) | | Record the last transition that executed in the executing flow. This
method will be called as part of executing a transition from one state to
another.
Parameters:
lastTransition - the last transition that executed
See Also: Transition.execute(StateRequestControlContext) |
| signalEvent | | public ViewSelection signalEvent(Event event) throws FlowExecutionException(Code) | | Signals the occurence of an event in the current state of this flow
execution request context. This method should be called by clients that
report internal event occurences, such as action states. The
onEvent() method of the flow involved in the flow
execution will be called.
Parameters:
event - the event that occured the next selected view, which returns control to the client andrequests that a view be rendered with model data
throws:
FlowExecutionException - if an exception was thrown within a stateof the flow during execution of this signalEvent operation
See Also: Flow.onEvent(RequestControlContext) |
| start | | public ViewSelection start(Flow flow, MutableAttributeMap input) throws FlowExecutionException(Code) | | Spawn a new flow session and activate it in the currently executing flow.
Also transitions the spawned flow to its start state. This method should
be called by clients that wish to spawn new flows, such as subflow
states.
This will start a new flow session in the current flow execution, which
is already active.
Parameters:
flow - the flow to start, its start() method will becalled
Parameters:
input - initial contents of the newly created flow session (may benull, e.g. empty) the selected starting view, which returns control to the clientand requests that a view be rendered with model data
throws:
FlowExecutionException - if an exception was thrown within a stateof the flow during execution of this start operation
See Also: Flow.start(RequestControlContextMutableAttributeMap) |
|
|