com.ibm.portal.pcm.dialog.dcx
Interface DCX

All Superinterfaces:

Disposable, Identifiable, java.io.Serializable, TimeStamped

public interface DCX
extends TimeStamped, Identifiable, Disposable, java.io.Serializable

The Dialog Controller ConteXt (DCX) accessor provides access to the public available information of the associated dialog instance.

Since:

8.0.0

See Also:

DialogDefinition, DCXData

Method Summary

DCXData	getDCXData() Returns the dialog controller context data which holds dialog scoped meta information which are available to all participants of the associated dialog instance.
java.util.List<DCX>	getDialogContextTrail() Returns the trail of dialog contexts which led to this dialog context.
DialogDefinition	getDialogDefinition() Returns the dialog dialog definition of the current dialog.
ObjectID	getDialogInstanceId() Returns the dialog instance ObjectID of the current dialog.

Methods inherited from interface com.ibm.portal.TimeStamped

getCreated, getLastModified

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

getDialogInstanceId

ObjectID getDialogInstanceId()

Returns the dialog instance ObjectID of the current dialog.

Returns:

ObjectID of the current dialog instance, never null.

getDialogDefinition

DialogDefinition getDialogDefinition()

Returns the dialog dialog definition of the current dialog.

Returns:

DialogDefinition of the current dialog, never null.

getDCXData

DCXData getDCXData()

Returns the dialog controller context data which holds dialog scoped meta information which are available to all participants of the associated dialog instance.

Returns:

DCXData object which can be used to access the dialog scoped data (never null).

getDialogContextTrail

java.util.List<DCX> getDialogContextTrail()

Returns the trail of dialog contexts which led to this dialog context.

Returns:

List of DCX objects.