public interface State
A State
is an executable entity, within the scope of an
owning Dialog
. Execution of a State
returns a logical
outcome (represented as a String), which is used to select the next
State
to be executed, via a Transition
.
Specialized subinterfaces of State
are defined for the
standard execution entity types that are supported, including:
ActionState
- Execution of an action method (typically
delegating behavior to appropriate business logic).SubdialogState
- Execution of a separate Dialog
,
with continuation based on the logical outcome returned by the
ending State
within the subordinate dialog.ViewState
- Execution of the rendering of a JavaServer
Faces view
, and returning the logical outcome returned
by the action method that processes the subsequent submit.EndState
- Specialized ViewState
that also marks
the end of execution of this Dialog
.Modifier and Type | Method and Description |
---|---|
Transition |
findTransition(String outcome)
Return the
Transition for the specified logical outcome,
if any; otherwise, return null . |
Dialog |
getDialog()
|
String |
getName()
|
Iterator |
getTransitionOutcomes()
|
String getName()
Return the identifier of this State
, which must be unique
among the State
s owned by the same Dialog
.
State
Iterator getTransitionOutcomes()
Return an Iterator
over the logical outcomes of
local Transition
s for this State
. If there are
no such Transition
s, an empty Iterator
is
returned.
Iterator
over the logical outcomes of local
Transition
s for this State
Transition findTransition(String outcome)
Return the Transition
for the specified logical outcome,
if any; otherwise, return null
.
outcome
- Logical outcome for which to return a Transition
Transition
for the specified outcome, may be nullCopyright © 2004-2013 Apache Software Foundation. All Rights Reserved.