| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Globals |
|
| 0.0;0 |
| 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.scxml; | |
| 19 | ||
| 20 | import org.apache.shale.dialog.scxml.impl.DefaultDialogStateMapper; | |
| 21 | ||
| 22 | /** | |
| 23 | * <p>Manifest constants and well known event names for the | |
| 24 | * Jakarta Commons SCXML driven Shale dialog implementation.</p> | |
| 25 | * | |
| 26 | * @since 1.0.4 | |
| 27 | */ | |
| 28 | 0 | public class Globals { |
| 29 | ||
| 30 | ||
| 31 | /** | |
| 32 | * <p>Context initialization paramater name under which a comma separated | |
| 33 | * list of configuration resources to be parsed exists.</p> | |
| 34 | */ | |
| 35 | public static final String CONFIGURATION = | |
| 36 | "org.apache.shale.dialog.scxml.CONFIGURATION"; | |
| 37 | ||
| 38 | ||
| 39 | /** | |
| 40 | * <p>Application scope attribute under which a <code>Map</code> of | |
| 41 | * dialog definitions (keyed by dialog name) is stored. A dialog | |
| 42 | * definition is the Commons SCXML object model describing the dialog | |
| 43 | * state machine.</p> | |
| 44 | */ | |
| 45 | public static final String DIALOGS = | |
| 46 | "org.apache.shale.dialog.scxml.DIALOGS"; | |
| 47 | ||
| 48 | ||
| 49 | /** | |
| 50 | * <p>Application scope attribute under which the current | |
| 51 | * {@link DialogStateMapper} implementation resides. Defaults to | |
| 52 | * {@link DefaultDialogStateMapper}.</p> | |
| 53 | */ | |
| 54 | public static final String STATE_MAPPER = | |
| 55 | "org$apache$shale$dialog$scxml$STATE_MAPPER"; | |
| 56 | ||
| 57 | ||
| 58 | /** | |
| 59 | * <p>The name of the postback event that the state machines should | |
| 60 | * use to author transitions for, out of a "view" state.</p> | |
| 61 | */ | |
| 62 | public static final String POSTBACK_EVENT = | |
| 63 | "faces.outcome"; | |
| 64 | ||
| 65 | ||
| 66 | /** | |
| 67 | * <p>The variable that holds the postback outcome in the root context | |
| 68 | * of the state machine instance. Expressions within the SCXML document | |
| 69 | * can then make references to this variable.</p> | |
| 70 | */ | |
| 71 | public static final String POSTBACK_OUTCOME = | |
| 72 | "outcome"; | |
| 73 | ||
| 74 | ||
| 75 | /** | |
| 76 | * <p>The namespace URI for the custom Commons SCXML actions defined by | |
| 77 | * the Shale dialogs Commons SCXML implementation.</p> | |
| 78 | */ | |
| 79 | public static final String CUSTOM_SCXML_ACTIONS_URI = | |
| 80 | "http://shale.apache.org/dialog-scxml"; | |
| 81 | ||
| 82 | ||
| 83 | /** | |
| 84 | * <p>The key for saving dialog properties in the root context of the | |
| 85 | * underlying Commons SCXML state machine. SCXML documents describing | |
| 86 | * dialogs <em>must not</em> use this key as a <var> or <data> | |
| 87 | * name.</p> | |
| 88 | */ | |
| 89 | public static final String DIALOG_PROPERTIES = | |
| 90 | "ReservedShaleDialogPropertiesKey"; | |
| 91 | ||
| 92 | ||
| 93 | } | |
| 94 |