| org.springframework.webflow.executor.FlowExecutor
All known Subclasses: org.springframework.webflow.executor.FlowExecutorImpl,
| FlowExecutor | | public interface FlowExecutor (Code) | | The central facade and entry-point service interface into the Spring Web Flow
system for driving the executions of flow definitions. This interface
defines a coarse-grained system boundary suitable for invocation by most
clients.
Implementations of this interface abstract away much of the internal
complexity of the web flow execution subsystem, which consists of launching
and resuming managed flow executions from repositories.
author:
Keith Donald |
| launch | | public ResponseInstruction launch(String flowDefinitionId, ExternalContext context) throws FlowException(Code) | | Launch a new execution of identified flow definition in the context of
the current external client request.
Parameters:
flowDefinitionId - the unique id of the flow definition to launch
Parameters:
context - the external context representing the state of a requestinto Spring Web Flow from an external system the starting response instruction
throws:
FlowException - if an exception occured launching the new flowexecution |
| refresh | | public ResponseInstruction refresh(String flowExecutionKey, ExternalContext context) throws FlowException(Code) | | Reissue the last response instruction issued by the flow execution. This is
a logical refresh operation that allows the "current response" to be
re-issued. This operation is idempotent and does not affect the state of the flow
execution.
Parameters:
flowExecutionKey - the identifying key of a paused flow executionthat is waiting to resume on the ocurrence of a user event
Parameters:
context - the external context representing the state of a requestinto Spring Web Flow from an external system the current response instruction
throws:
FlowException - if an exception occured retrieving the currentresponse instruction |
| resume | | public ResponseInstruction resume(String flowExecutionKey, String eventId, ExternalContext context) throws FlowException(Code) | | Resume an existing, paused flow execution by signaling an event against
its current state.
Parameters:
flowExecutionKey - the identifying key of a paused flow executionthat is waiting to resume on the occurrence of a user event
Parameters:
eventId - the user event that occured
Parameters:
context - the external context representing the state of a requestinto Spring Web Flow from an external system the next response instruction
throws:
FlowException - if an exception occured resuming the existing flowexecution |
|
|