public final class Constants extends Object
Manifest constants related to the integration of state machine implementations into the Shale Dialog Manager.
Modifier and Type | Field and Description |
---|---|
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 |
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 and Description |
---|
Constants() |
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.
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.
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.
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.
public static final String DIALOG_PREFIX
Default prefix on a logical outcome that indicates a new dialog instance should be initiated.
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.
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.
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.
Copyright © 2004-2013 Apache Software Foundation. All Rights Reserved.