com.ibm.portal.pcm
Interface DialogService

All Superinterfaces:

PortletService

public interface DialogService
extends PortletService

The dialog service interface does provide access to several dialog related services in the same scope this service has been retrieved for.

Since:

8.0.0

See Also:

DialogStateManager, DialogStackManager, DCXManager

Method Summary

DCXManager	getDCXManager() Returns the dialog context manager.
DialogDefinition	getDialogDefinition() Returns the DialogDefinition corresponding to the dialog that is currently executing.
ObjectID	getDialogInstanceID() Deprecated. Do not use this method to obtain the current dialog instance ObjectID, use getDialogStackManager() and DialogStackManager.getActiveDCX() instead.
DialogStackManager	getDialogStackManager() Returns the dialog stack manager.
DialogStateManager	getDialogStateManager() Returns the dialog state manager.
ListModel<ObjectID>	getSuspendedDialogInstanceIDs() Deprecated. Do not use this method to obtain the suspended dialog instance ObjectIDs, use getDialogStackManager() and DialogStackManager.getSuspendedDCXs() instead.

Method Detail

getDialogDefinition

DialogDefinition getDialogDefinition()

Returns the DialogDefinition corresponding to the dialog that is currently executing.

Returns:

DialogDefinition of the currently active dialog.

getDialogInstanceID

ObjectID getDialogInstanceID()

Deprecated. Do not use this method to obtain the current dialog instance ObjectID, use getDialogStackManager() and DialogStackManager.getActiveDCX() instead.

Returns the currently active (running) dialog instance ObjectID.

Returns:

The ObjectID of the currently running dialog, null if no dialog is running.

getSuspendedDialogInstanceIDs

ListModel<ObjectID> getSuspendedDialogInstanceIDs()

Deprecated. Do not use this method to obtain the suspended dialog instance ObjectIDs, use getDialogStackManager() and DialogStackManager.getSuspendedDCXs() instead.

Returns the current list of suspended dialog instance ObjectIDs.

Returns:

A ListModel containing the list of suspended dialog instances, never null.

getDialogStateManager

DialogStateManager getDialogStateManager()

Returns the dialog state manager.

Returns:

A DialogStateManager valid in the scope this dialog service is valid in. Never null.

getDialogStackManager

DialogStackManager getDialogStackManager()

Returns the dialog stack manager.

Returns:

A DialogStackManager valid in the scope this dialog service is valid in. Never null.

getDCXManager

DCXManager getDCXManager()

Returns the dialog context manager.

Returns:

A DCXManager valid in the scope this dialog service is valid in. Never null.