com.ibm.portal.pcm.events
Interface DialogStartPayload

All Superinterfaces:

java.io.Serializable

public interface DialogStartPayload
extends java.io.Serializable

This class represents the well-defined special start payload which can be used to initiate a new dialog.

Since:

8.0.0

See Also:

Constants.PCM_START_QNAME

Method Summary

java.lang.String	getDialogDefinitionName() Returns the dialog definition name.
java.util.Map<javax.xml.namespace.QName,java.lang.Object>	getInitializationData() Returns the initialization data stored in the start payload object.
java.lang.Object	getInitializationPayload() Returns the initialization payload to be used.

Method Detail

getDialogDefinitionName

java.lang.String getDialogDefinitionName()

Returns the dialog definition name. This optional field specifies an additional constraint for the dispatching routines to identify the respective dialog to start. It can be omitted as long as all start transitions of all dialog definitions are unique in terms of event sender and event QName and therefore the only matching dialog found will be started.

Returns:

String with the dialog definition name. This can be null.

getInitializationPayload

java.lang.Object getInitializationPayload()

Returns the initialization payload to be used. This payload will be used for the target Event to the first dialog participant.

Returns:

Object which represents the initialization payload. This can be null.

getInitializationData

java.util.Map<javax.xml.namespace.QName,java.lang.Object> getInitializationData()

Returns the initialization data stored in the start payload object. These initialization data will be added to the DCX and can be used throughout the dialog.

Returns:

Map with the initialization data. This can be null.