com.ibm.portal.pcm.dialog.state
Interface DialogStep

All Superinterfaces:

Localized

public interface DialogStep
extends Localized

A dialog step does represent an existing or potential invocation of a modeled transition within a given dialog.

Since:

8.0.0

See Also:

Localized

Method Summary

DialogDefinition	getDialogDefinition() Returns the dialog definition this particular dialog step belongs to.
ObjectID	getTargetEndpointID() Returns the target endpoint ObjectID.
java.lang.String	getTargetEndpointName() Return the target endpoint name.
javax.xml.namespace.QName	getTargetEventName() Return the target event QName.
boolean	isCurrent() Checks whether this dialog step is the currently active one.
boolean	isNested() Checks whether this dialog step is used in a nested fashion.

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Method Detail

getTargetEndpointID

ObjectID getTargetEndpointID()

Returns the target endpoint ObjectID.

Returns:

The ObjectID of the target TransitionEndpoint that was invoked during this dialog step.

getTargetEventName

javax.xml.namespace.QName getTargetEventName()

Return the target event QName.

Returns:

The event QName that is invoked on the target TransitionEndpoint when executing this dialog step.

getTargetEndpointName

java.lang.String getTargetEndpointName()

Return the target endpoint name.

Returns:

The target endpoint name which is defined in the dialog model.

getDialogDefinition

DialogDefinition getDialogDefinition()

Returns the dialog definition this particular dialog step belongs to.

Returns:

The DialogDefinition in which this dialog step can occur, or has occurred.

isNested

boolean isNested()

Checks whether this dialog step is used in a nested fashion.

Returns:

Boolean true if it is nested, false otherwise.

isCurrent

boolean isCurrent()

Checks whether this dialog step is the currently active one.

Returns:

Boolean true if it is the current one, false otherwise.