|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DialogStackManager
Provides service related to suspending and resuming dialog instances. A dialog instance is represented by its
DCX
.
DCX
,
DialogStackManagerException
Method Summary | |
---|---|
void |
cancelCascadeDialogInstance(ObjectID dialogInstanceId)
Cancels the dialog instance which is associated with the provided dialog instance ObjectID . |
void |
cancelDialogInstance(ObjectID dialogInstanceId)
Cancels the dialog instance which is associated with the provided dialog instance ObjectID . |
DCX |
getActiveDCX()
Returns the currently active dialog context. |
IterableListModel<? extends DCX> |
getSuspendedDCXs()
Returns a list of suspended dialog contexts. |
IterableListModel<? extends DCX> |
getWaitingDCXs()
Returns a list of the currently waiting dialog context. |
void |
resumeDialogInstance(ObjectID dialogInstanceId)
Resumes the dialog instance which is associated with the provided dialog instance ObjectID . |
void |
returnToDialogInstance(ObjectID dialogInstanceId)
Returns to the dialog instance which is associated with the provided dialog instance ObjectID . |
void |
suspendDialogInstance(ObjectID dialogInstanceId)
Suspends the dialog instance which is associated with the provided dialog instance ObjectID . |
Method Detail |
---|
DCX getActiveDCX() throws DialogStackManagerException
DCX
which points to the currently active dialog context, or null
if there is no
active dialog instance.
DialogStackManagerException
- In case of issues with possibly stale runtime variables. An attached cause
should point to the source of the problem.IterableListModel<? extends DCX> getSuspendedDCXs() throws DialogStackManagerException
IterableListModel
with DCX
s which are currently suspended, never null
.
DialogStackManagerException
- In case of issues with possibly stale runtime variables. An attached cause
should point to the source of the problem.void returnToDialogInstance(ObjectID dialogInstanceId) throws DialogStackManagerException
ObjectID
.
dialogInstanceId
- The dialog instance id of the dialog.
DialogStackManagerException
- In any case of errors during dialog stack operations. A cause will be
attached if necessary.void resumeDialogInstance(ObjectID dialogInstanceId) throws DialogStackManagerException
ObjectID
.
dialogInstanceId
- The dialog instance id of the dialog.
DialogStackManagerException
- In any case of errors during dialog stack operations. A cause will be
attached if necessary.void cancelDialogInstance(ObjectID dialogInstanceId) throws DialogStackManagerException
ObjectID
.
dialogInstanceId
- The dialog instance id of the dialog.
DialogStackManagerException
- In any case of errors during dialog stack operations. A cause will be
attached if necessary.void suspendDialogInstance(ObjectID dialogInstanceId) throws DialogStackManagerException
ObjectID
.
dialogInstanceId
- The dialog instance id of the dialog.
DialogStackManagerException
- In any case of errors during dialog stack operations. A cause will be
attached if necessary.void cancelCascadeDialogInstance(ObjectID dialogInstanceId) throws DialogStackManagerException
ObjectID
. If given
instance is part of a nested dialog all waiting dialog instances will be canceled too.
dialogInstanceId
- The dialog instance id of the dialog.
DialogStackManagerException
- In any case of errors during dialog stack operations. A cause will be
attached if necessary.IterableListModel<? extends DCX> getWaitingDCXs() throws DialogStackManagerException
DCX
which points to the currently active dialog context, or null
if there is no
active dialog instance.
DialogStackManagerException
- In case of issues with possibly stale runtime variables. An attached cause
should point to the source of the problem.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |