org.apache.shale.dialog
Class Constants

java.lang.Object
  org.apache.shale.dialog.Constants

public final class Constants
extends Object

Manifest constants related to the integration of state machine implementations into the Shale Dialog Manager.

Since:

1.0.4

Field Summary

static String	CONTEXT_BEAN Request scoped attribute under which the DialogContext instance for the dialog that is active for this view (if any) is stored.
static String	DIALOG_ID Request parameter containing the dialog identifier of an existing DialogContext instance to be restored for the current view.
static String	DIALOG_NAME Request parameter containing the logical name of a new DialogContext instance to be created for the current view, if there is no active instance already.
static String	DIALOG_PREFIX Default prefix on a logical outcome that indicates a new dialog instance should be initiated.
static String	DIALOG_PREFIX_PARAM Context initialization attribute that specifies an override for the default prefix on a logical outcome that indicates a new dialog instance should be initiated.
static String	DIALOG_SCOPE Name of a "managed bean" that represents the data associated with the dialog context instance for the current request (if any).
static String	LIFECYCLE_ATTR Application scope attribute under which the application may optionally define an instance of DialogLifecycleListener to receive notification of the creation and removal of DialogContextManager instances.
static String	MANAGER_BEAN Session scoped attribute under which the DialogContextManager instance for this user (if any) is stored.
static String	PARENT_ID Request parameter containing the DialogContext instance identifier of a parent instance with which a new child DialogContext instance (to be created for the current view) should be associated.

Constructor Summary

Constants()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT_BEAN

public static final String CONTEXT_BEAN

Request scoped attribute under which the DialogContext instance for the dialog that is active for this view (if any) is stored.

See Also:

Constant Field Values

DIALOG_ID

public static final String DIALOG_ID

Request parameter containing the dialog identifier of an existing DialogContext instance to be restored for the current view. Normally, this identifier will be passed implicitly as part of the JSF view state, but must be passed explicitly if navigation to a view is performed by a redirect.

See Also:

Constant Field Values

DIALOG_NAME

public static final String DIALOG_NAME

Request parameter containing the logical name of a new DialogContext instance to be created for the current view, if there is no active instance already. If the request parameter specified by Constants.PARENT_ID is also specified, the new instance will be associated with that instance as a parent.

See Also:

Constant Field Values

DIALOG_SCOPE

public static final String DIALOG_SCOPE

Name of a "managed bean" that represents the data associated with the dialog context instance for the current request (if any).

Since:

1.1

See Also:

Constant Field Values

LIFECYCLE_ATTR

public static final String LIFECYCLE_ATTR

Application scope attribute under which the application may optionally define an instance of DialogLifecycleListener to receive notification of the creation and removal of DialogContextManager instances.

See Also:

Constant Field Values

DIALOG_PREFIX

public static final String DIALOG_PREFIX

Default prefix on a logical outcome that indicates a new dialog instance should be initiated.

See Also:

Constant Field Values

DIALOG_PREFIX_PARAM

public static final String DIALOG_PREFIX_PARAM

Context initialization attribute that specifies an override for the default prefix on a logical outcome that indicates a new dialog instance should be initiated.

See Also:

Constant Field Values

MANAGER_BEAN

public static final String MANAGER_BEAN

Session scoped attribute under which the DialogContextManager instance for this user (if any) is stored. A particular integration will typically declare itself to be a session scoped managed bean with this name.

See Also:

Constant Field Values

PARENT_ID

public static final String PARENT_ID

Request parameter containing the DialogContext instance identifier of a parent instance with which a new child DialogContext instance (to be created for the current view) should be associated. Any value for this request parameter will only be processed if the current view has no currently active DialogContext instance.

See Also:

Constant Field Values

Constructor Detail

Constants

public Constants()