2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shale.dialog;
19  
20  /***
21   * <p>Manifest constants related to the integration of state machine
22   * implementations into the Shale Dialog Manager.</p>
23   *
24   * @since 1.0.4
25   */
26  public final class Constants {
27  
28  
29      /***
30       * <p>Request scoped attribute under which the {@link DialogContext} instance
31       * for the dialog that is active for this view (if any) is stored.</p>
32       */
33      public static final String CONTEXT_BEAN = "dialog";
34  
35  
36      /***
37       * <p>Request parameter containing the dialog identifier of an
38       * existing {@link DialogContext} instance to be restored for
39       * the current view.  Normally, this identifier will be passed
40       * implicitly as part of the JSF view state, but must be passed
41       * explicitly if navigation to a view is performed by a redirect.</p>
42       */
43      public static final String DIALOG_ID =
44              "org.apache.shale.dialog.DIALOG_ID";
45  
46  
47      /***
48       * <p>Request parameter containing the logical name of a new
49       * {@link DialogContext} instance to be created for the current view, if
50       * there is no active instance already.  If the request parameter
51       * specified by <code>Constants.PARENT_ID</code> is also specified,
52       * the new instance will be associated with that instance as a parent.</p>
53       */
54      public static final String DIALOG_NAME =
55              "org.apache.shale.dialog.DIALOG_NAME";
56  
57  
58      /***
59       * <p>Name of a "managed bean" that represents the data associated with the
60       * dialog context instance for the current request (if any).</p>
61       *
62       * @since 1.1
63       */
64      public static final String DIALOG_SCOPE = "dialogScope";
65  
66  
67      /*** 
68       * <p>Application scope attribute under which the application may optionally
69       * define an instance of {@link DialogLifecycleListener} to receive
70       * notification of the creation and removal of {@link DialogContextManager}
71       * instances.
72       */
73      public static final String LIFECYCLE_ATTR =
74              "org.apache.shale.dialog.LIFECYCLE_LISTENER";
75  
76  
77      /***
78       * <p>Default prefix on a logical outcome that indicates a new dialog instance
79       * should be initiated.</p>
80       */
81      public static final String DIALOG_PREFIX = "dialog:";
82  
83  
84      /***
85       * <p>Context initialization attribute that specifies an override for the
86       * default prefix on a logical outcome that indicates a new dialog instance
87       * should be initiated.</p>
88       */
89      public static final String DIALOG_PREFIX_PARAM =
90              "org.apache.shale.dialog.DIALOG_PREFIX";
91  
92  
93      /***
94       * <p>Session scoped attribute under which the {@link DialogContextManager}
95       * instance for this user (if any) is stored.  A particular integration will
96       * typically declare itself to be a session scoped managed bean with
97       * this name.</p>
98       */
99      public static final String MANAGER_BEAN =
100             "org.apache.shale.dialog.MANAGER";
101 
102 
103     /***
104      * <p>Request parameter containing the {@link DialogContext} instance identifier
105      * of a parent instance with which a new child {@link DialogContext} instance
106      * (to be created for the current view) should be associated.  Any value for
107      * this request parameter will only be processed if the current view has no
108      * currently active {@link DialogContext} instance.</p>
109      */
110     public static final String PARENT_ID =
111             "org.apache.shale.dialog.PARENT_ID";
112 
113 
114 }