|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Dialog
Overall configuration of an individual dialog. During application execution, this information is immutable (so that simultaneous execution threads may be processing states or transitions through this dialog). Therefore, access to configuration information is not synchronized.
A Dialog
is characterized by a set of named State
s,
which are executed in an order that is determined by Transition
s
between those State
s. Execution of a Dialog
begins at
the State
specified by the start
property, and ends
when an EndState
is executed.
Transition
s describe the rule that determines the name of the
next State
to be executed, based upon a logical outcome returned
by the execution of a previous State
. Transition
s
associated with a Dialog
define dialog-wide rules for specified
outcomes, while Transition
s associated with a particular
State
can replace the global Transition
that would normally
be selected with one specific to the executing State
.
Method Summary | |
---|---|
State |
findState(String id)
Return the specified State , owned by this Dialog ,
if any. |
Transition |
findTransition(String outcome)
Return the global Transition for the specified logical outcome,
if any; otherwise, return null . |
String |
getName()
Return the name of this Dialog . |
String |
getStart()
Return the name of the starting State for this
Dialog . |
Iterator |
getStateIds()
Return an Iterator over the names of State s
that are owned by this Dialog . |
Iterator |
getTransitionOutcomes()
Return an Iterator over the logical outcomes of
global Transition s for this Dialog . |
Method Detail |
---|
String getName()
Return the name of this Dialog
.
String getStart()
Iterator getStateIds()
Return an Iterator
over the names of State
s
that are owned by this Dialog
. If there are no such
State
s, an empty Iterator
is returned.
Iterator getTransitionOutcomes()
Return an Iterator
over the logical outcomes of
global Transition
s for this Dialog
. If there are
no such Transition
s, an empty Iterator
is
returned.
State findState(String id)
Return the specified State
, owned by this Dialog
,
if any. Otherwise, return null
.
id
- Identifier of the requested State
Transition findTransition(String outcome)
Return the global Transition
for the specified logical outcome,
if any; otherwise, return null
.
outcome
- Logical outcome for which to return a Transition
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |