|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DialogStateManager
Provides services related to the various DialogStep
s of the dialog that is currently running. Use this dialog
state manager only if a dialog is currently active. If no dialog is currently active, this manager will return empty
objects.
Nested Class Summary | |
---|---|
static class |
DialogStateManager.Scope
Scope in which dialog state details should be accumulated. |
Method Summary | |
---|---|
boolean |
canGoBackward()
|
boolean |
canGoForward()
|
boolean |
canJumpTo(DialogStep target)
Checks whether a jumpTo(DialogStep) operation is possible for the given dialog step. |
boolean |
canJumpTo(int index)
Deprecated. Use canJumpTo(DialogStep) instead, since index based jumps are not feasible for dialog
nesting scenarios. |
DialogStep |
getCurrentStep()
|
OutboundGraph<DialogStep> |
getNextStepGraph()
|
OutboundGraph<DialogStep> |
getNextStepGraph(DialogStateManager.Scope scope)
|
IterableListModel<DialogStep> |
getProcessedSteps()
Returns the list of already processed dialog steps. |
IterableListModel<DialogStep> |
getProcessedSteps(DialogStateManager.Scope scope)
Returns the list of already processed dialog steps. |
void |
goBackward()
Will redirect to the previous in the list of already processed dialog steps. |
void |
goForward()
Will redirect to the next in the list of already processed dialog steps. |
void |
jumpTo(DialogStep target)
Will redirect to the respective dialog step that is given as the input parameter. |
void |
jumpTo(int index)
Deprecated. Use jumpTo(DialogStep) instead, since index based jumps are not feasible for dialog nesting
scenarios. |
Method Detail |
---|
DialogStep getCurrentStep() throws DialogStateManagerException
DialogStateManagerException
- in case a problem occurs while retrieving the current dialog stepIterableListModel<DialogStep> getProcessedSteps() throws DialogStateManagerException
DialogStep
s that have been processed up to this point.
DialogStateManagerException
- In case a problem occurs while retrieving the processed dialog steps.IterableListModel<DialogStep> getProcessedSteps(DialogStateManager.Scope scope) throws DialogStateManagerException
scope
- The DialogStateManager.Scope
in which the list of dialog steps should be created.
DialogStep
s that have been processed up to this point.
DialogStateManagerException
- In case a problem occurs while retrieving the processed dialog steps.OutboundGraph<DialogStep> getNextStepGraph() throws DialogStateManagerException
OutboundGraph
representing the possible next steps starting from a given step.
DialogStateManagerException
- in case a problem occurs while retrieving the graph representing the next
dialog stepsOutboundGraph<DialogStep> getNextStepGraph(DialogStateManager.Scope scope) throws DialogStateManagerException
scope
- The DialogStateManager.Scope
in which the next step graph should be created.
OutboundGraph
representing the possible next steps starting from a given step.
DialogStateManagerException
- in case a problem occurs while retrieving the graph representing the next
dialog stepsboolean canGoForward() throws DialogStateManagerException
true
if it is possible to go forward in the sequence of processed dialog steps,
false
otherwise.
DialogStateManagerException
- In case a problem occurs while checking whether it is possible to go forward.boolean canGoBackward() throws DialogStateManagerException
true
if it is possible to go backward in the sequence of processed dialog steps,
false
otherwise.
DialogStateManagerException
- in case a problem occurs while checking whether it is possible to go
backward.boolean canJumpTo(int index) throws DialogStateManagerException
canJumpTo(DialogStep)
instead, since index based jumps are not feasible for dialog
nesting scenarios.
index
- The index of the processed dialog step to jump to.
true
if it is possible to jump to the desired index, false
otherwise.
DialogStateManagerException
- In case a problem occurs while checking whether it is possible to jump to.void goForward() throws DialogStateManagerException
canGoForward()
.
DialogStateManagerException
- in case a problem occurs while triggering a forwardvoid goBackward() throws DialogStateManagerException
canGoBackward()
.
DialogStateManagerException
- in case a problem occurs while triggering a backward callvoid jumpTo(int index) throws DialogStateManagerException
jumpTo(DialogStep)
instead, since index based jumps are not feasible for dialog nesting
scenarios.
index
- The index of the processed dialog step to jump to.
DialogStateManagerException
- in case a problem occurs while triggering a jump to a specific transition
endpointboolean canJumpTo(DialogStep target) throws DialogStateManagerException
jumpTo(DialogStep)
operation is possible for the given dialog step.
target
- The DialogStep
to check whether a jump back or forward is manageable
true
if it is possible to jump to the desired dialog step, false
otherwise.
DialogStateManagerException
- In case a problem occurs while checking whether it is possible to jump to.void jumpTo(DialogStep target) throws DialogStateManagerException
canJumpTo(DialogStep)
beforehand.
target
- The DialogStep
to jump back or forward to.
DialogStateManagerException
- In any case of exceptions in the underlying methods, e.g. invalid target or
missing portal resources.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |