public class EndState extends State
If the ended session is the "root flow session" the entire flow execution ends, signaling the end of a logical conversation.
If the terminated session was acting as a subflow, the flow execution continues and control is returned to the parent flow session. In that case, this state returns an ending result event the resuming parent flow responds to.
An end state may be configured with a renderer to render a final response. This renderer will be invoked if the end state terminates the entire flow execution.
SubflowState
CAPTION_PROPERTY, DESCRIPTION_PROPERTY
Constructor and Description |
---|
EndState(Flow flow,
String id)
Create a new end state with no associated view.
|
Modifier and Type | Method and Description |
---|---|
void |
setFinalResponseAction(Action finalResponseAction)
Sets the renderer that will render the final flow execution response.
|
void |
setOutputMapper(Mapper outputMapper)
Sets the attribute mapper to use for mapping output attributes exposed by this end state when it is entered.
|
enter, equals, getEntryActionList, getExceptionHandlerSet, getFlow, getId, getOwner, handleException, hashCode, isStartState, isViewState, toString
getAttributes, getCaption, getDescription, setCaption, setDescription
getAttributes, getCaption, getDescription
public EndState(Flow flow, String id) throws IllegalArgumentException
flow
- the owning flowid
- the state identifier (must be unique to the flow)IllegalArgumentException
- when this state cannot be added to given flow, e.g. because the id is not uniqueState.State(Flow, String)
,
setFinalResponseAction(Action)
,
setOutputMapper(Mapper)
public void setFinalResponseAction(Action finalResponseAction)
public void setOutputMapper(Mapper outputMapper)