com.ibm.portal.pcm.dialog.stack
Interface DialogStackManager

public interface DialogStackManager

Provides service related to suspending and resuming dialog instances. A dialog instance is represented by its DCX.

Since:

8.0.0

See Also:

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

getActiveDCX

DCX getActiveDCX()
                 throws DialogStackManagerException

Returns the currently active dialog context.

Returns:

DCX which points to the currently active dialog context, or null if there is no active dialog instance.

Throws:

DialogStackManagerException - In case of issues with possibly stale runtime variables. An attached cause should point to the source of the problem.

getSuspendedDCXs

IterableListModel<? extends DCX> getSuspendedDCXs()
                                                  throws DialogStackManagerException

Returns a list of suspended dialog contexts.

Returns:

A IterableListModel with DCXs which are currently suspended, never null.

Throws:

DialogStackManagerException - In case of issues with possibly stale runtime variables. An attached cause should point to the source of the problem.

returnToDialogInstance

void returnToDialogInstance(ObjectID dialogInstanceId)
                            throws DialogStackManagerException

Returns to the dialog instance which is associated with the provided dialog instance ObjectID.

Parameters:

dialogInstanceId - The dialog instance id of the dialog.

Throws:

DialogStackManagerException - In any case of errors during dialog stack operations. A cause will be attached if necessary.

resumeDialogInstance

void resumeDialogInstance(ObjectID dialogInstanceId)
                          throws DialogStackManagerException

Resumes the dialog instance which is associated with the provided dialog instance ObjectID.

Parameters:

dialogInstanceId - The dialog instance id of the dialog.

Throws:

DialogStackManagerException - In any case of errors during dialog stack operations. A cause will be attached if necessary.

cancelDialogInstance

void cancelDialogInstance(ObjectID dialogInstanceId)
                          throws DialogStackManagerException

Cancels the dialog instance which is associated with the provided dialog instance ObjectID.

Parameters:

dialogInstanceId - The dialog instance id of the dialog.

Throws:

DialogStackManagerException - In any case of errors during dialog stack operations. A cause will be attached if necessary.

suspendDialogInstance

void suspendDialogInstance(ObjectID dialogInstanceId)
                           throws DialogStackManagerException

Suspends the dialog instance which is associated with the provided dialog instance ObjectID.

Parameters:

dialogInstanceId - The dialog instance id of the dialog.

Throws:

DialogStackManagerException - In any case of errors during dialog stack operations. A cause will be attached if necessary.

cancelCascadeDialogInstance

void cancelCascadeDialogInstance(ObjectID dialogInstanceId)
                                 throws DialogStackManagerException

Cancels the dialog instance which is associated with the provided dialog instance ObjectID. If given instance is part of a nested dialog all waiting dialog instances will be canceled too.

Parameters:

dialogInstanceId - The dialog instance id of the dialog.

Throws:

DialogStackManagerException - In any case of errors during dialog stack operations. A cause will be attached if necessary.

getWaitingDCXs

IterableListModel<? extends DCX> getWaitingDCXs()
                                                throws DialogStackManagerException

Returns a list of the currently waiting dialog context.

Returns:

DCX which points to the currently active dialog context, or null if there is no active dialog instance.

Throws:

DialogStackManagerException - In case of issues with possibly stale runtime variables. An attached cause should point to the source of the problem.