| |
|
| java.lang.Object org.springframework.webflow.executor.ResponseInstruction
ResponseInstruction | public class ResponseInstruction implements Serializable(Code) | | Immutable value object that provides clients with information about a
response to issue.
There are five different types of response instruction:
author: Keith Donald author: Erwin Vervaet |
Method Summary | |
public boolean | equals(Object o) | public FlowExecutionContext | getFlowExecutionContext() Returns the flow execution context representing the current state of the
execution. | public String | getFlowExecutionKey() Returns the persistent identifier of the flow execution. | public ViewSelection | getViewSelection() Returns the view selection selected by the flow execution. | public int | hashCode() | public boolean | isActiveView() Returns true if this is an instruction to render an application view for
an "active" (in progress) flow execution. | public boolean | isApplicationView() Returns true if this is an "application view" (forward) response
instruction. | public boolean | isEndingView() Returns true if this is an instruction to render an application view for
an "ended" (inactive) flow execution from an end state. | public boolean | isExternalRedirect() Returns true if this an instruction to perform a redirect to an external
URL. | public boolean | isFlowDefinitionRedirect() Returns true if this is an instruction to launch an entirely new
(independent) flow execution. | public boolean | isFlowExecutionRedirect() Returns true if this is an instruction to perform a redirect to the
current flow execution to render an application view. | public boolean | isNull() Returns true if this is a "null" response instruction, e.g. | public String | toString() |
ResponseInstruction | public ResponseInstruction(String flowExecutionKey, FlowExecutionContext flowExecutionContext, ViewSelection viewSelection)(Code) | | Create a new response instruction for a paused flow execution.
Parameters: flowExecutionKey - the persistent identifier of the flow execution Parameters: flowExecutionContext - the current flow execution context Parameters: viewSelection - the selected view |
ResponseInstruction | public ResponseInstruction(FlowExecutionContext flowExecutionContext, ViewSelection viewSelection)(Code) | | Create a new response instruction for an ended flow execution. No
flow execution key needs to be provided since the flow execution no longer
exists and cannot be referenced any longer.
Parameters: flowExecutionContext - the current flow execution context (inactive) Parameters: viewSelection - the selected view |
getFlowExecutionKey | public String getFlowExecutionKey()(Code) | | Returns the persistent identifier of the flow execution.
|
getViewSelection | public ViewSelection getViewSelection()(Code) | | Returns the view selection selected by the flow execution.
|
hashCode | public int hashCode()(Code) | | |
isActiveView | public boolean isActiveView()(Code) | | Returns true if this is an instruction to render an application view for
an "active" (in progress) flow execution.
|
isApplicationView | public boolean isApplicationView()(Code) | | Returns true if this is an "application view" (forward) response
instruction.
|
isEndingView | public boolean isEndingView()(Code) | | Returns true if this is an instruction to render an application view for
an "ended" (inactive) flow execution from an end state.
|
isExternalRedirect | public boolean isExternalRedirect()(Code) | | Returns true if this an instruction to perform a redirect to an external
URL.
|
isFlowDefinitionRedirect | public boolean isFlowDefinitionRedirect()(Code) | | Returns true if this is an instruction to launch an entirely new
(independent) flow execution.
|
isFlowExecutionRedirect | public boolean isFlowExecutionRedirect()(Code) | | Returns true if this is an instruction to perform a redirect to the
current flow execution to render an application view.
|
isNull | public boolean isNull()(Code) | | Returns true if this is a "null" response instruction, e.g.
no response needs to be rendered.
|
|
|
|