1    package com.instantbank.servicing.control.util;
2    
3    
4    /**
5     *  This interface contains all the keys that are used to store data in the
6     *  different scopes of web-tier. These values are the same as those used in the
7     *  JSP pages (useBean tags).
8     *
9     * @author Instant-bank (Consuelo Franky, Jorge Cardenas)
10    * @created September 2002
11    */
12   public interface WebKeys {
13   
14     // KEYS CORRESPONDING TO JAVABEANS WHICH ARE MODEL VIEW
15     // (WEB SESSION VARIABLES): no one
16   
17   
18     // KEYS CORRESPONDING TO WEB SESSION VARIABLES
19     // ASSOCIATED TO ENVIRONMENT VARIABLES OF servicing EAR:
20   
21     /**
22      * if it is true, the stacktrace will be shown to user
23      */
24     public static final String ExternalDebugMode = "externalDebugMode";
25   
26   
27     // KEYS CORRESPONDING TO WEB CONTEXT VARIABLES OF CONTROLLER:
28   
29     /**
30      * javaBean for selecting next screen
31      */
32     public static final String ScreenManagerKey = "screenManager";
33   
34     /**
35      * javaBean for processing request user
36      */
37     public static final String RequestProcessorKey = "rp";
38   
39     // KEYS CORRESPONDING TO WEB SESSION VARIABLES OF CONTROLLER:
40   
41     /**
42      * javaBean for sending request event to Service Layer
43      */
44     public static final String WebControllerKey = "webController";
45   
46     /**
47      * javaBean for updating model views in the Application Layer
48      */
49     public static final String ModelManagerKey = "mm";
50   
51     /**
52      * name of next screen to show to the user
53      */
54     public static final String CurrentScreen = "currentScreen";
55   
56     /**
57      * current language
58      */
59     public static final String LanguageKey = "language";
60   
61     /**
62      * list of missing data in the request user
63      */
64     public static final String MissingFormDataKey = "missingFormData";
65   
66     // KEYS CORRESPONDING TO WEB SESSION VARIABLES OBTAINED FROM COLLECTIONS :
67   
68     /**
69      * name of current company
70      */
71     public static final String CompanyName = "companyName";
72   
73     /**
74      * id of current company
75      */
76     public static final String CompanyId = "companyId";
77   
78     /**
79      * version of system
80      */
81     public static final String Version = "version";
82   
83     /**
84      * options of Collections
85      */
86     public static final String OptionCollections = "optionCollections";
87   
88     /**
89      * options of current company
90      */
91     public static final String OptionCompany = "optionCompany";
92   
93     /**
94      * signals an exception in Collections
95      */
96     public static final String HasException = "hasException";
97   
98     /**
99      * current user name
100     */
101    public static final String UserName = "userName";
102  
103    /**
104     * number of current company
105     */
106    public static final String CompanyNumber = "companyNumber";
107  
108    /**
109     * current userid
110     */
111    public static final String UserId = "userId";
112  
113    /**
114     * current usecase
115     */
116    public static final String UseCase = "useCase";
117  
118  
119    // KEYS FOR ANY USECASE
120    // by default (web request variables):
121  
122    /**
123     * signals that an exception occurred
124     */
125    public static final String ExceptionOcurred = "exceptionOcurred";
126  
127    /**
128     * stacktrace associated to the exception
129     */
130    public static final String ExceptionStackTrace = "exceptionStackTrace";
131  
132    // KEYS FOR parmLevelsName USECASE :
133  
134    /**
135     * current instance of ParmLevelsNameEvent
136     */
137    public static final String ParmLevelsNameEvent = "parmLevelsNameEvent";
138  
139    /**
140     * parameter levels name of current company
141     */
142    public static final String ParmLevelsNameList = "parmLevelsNameList";
143  
144    // KEYS FOR parmLevel1Values USECASE :
145  
146    /**
147     * current instance of ParmLevel1ValuesEvent
148     */
149    public static final String ParmLevel1ValuesEvent = "parmLevel1ValuesEvent";
150  
151    /**
152     * parameter level 1 values list of current company
153     */
154    public static final String ParmLevel1ValuesList = "parmLevel1ValuesList";
155  
156    // KEYS FOR parmLevel2Values USECASE :
157  
158    /**
159     * current instance of ParmLevel2ValuesEvent
160     */
161    public static final String ParmLevel2ValuesEvent = "parmLevel2ValuesEvent";
162  
163    /**
164     * parameter level 2 values list of current company
165     */
166    public static final String ParmLevel2ValuesList = "parmLevel2ValuesList";
167  
168    // KEYS FOR parmSearchOrder USECASE :
169  
170    /**
171     * current instance of ParmSearchOrderEvent
172     */
173    public static final String ParmSearchOrderEvent = "parmSearchOrderEvent";
174  
175    /**
176     * parameter search order of current company
177     */
178    public static final String ParmSearchOrderList = "parmSearchOrderList";
179  
180    // KEYS FOR parmRestrictions USECASE :
181  
182    /**
183     * current instance of ParmRestrictionsEvent
184     */
185    public static final String ParmRestrictionsEvent = "parmRestrictionsEvent";
186  
187    /**
188     * parameter restrictions of current company
189     */
190    public static final String ParmRestrictionsList = "parmRestrictionsList";
191  
192    /**
193     * codeParm table of all parameters (session variable)
194     */
195    public static final String ParmRestrictionsTable = "parmRestrictionTable";
196  
197    // KEYS FOR setParameterXValue USECASE :
198  
199    /**
200     * current instance of SetParametersValues
201     */
202    public static final String SetParametersValues = "setParametersValues";
203  
204    /**
205     * current instance of SetParameterXValueEvent
206     */
207    public static final String SetParameterXValueEvent = "setParameterXValueEvent";
208  
209    /**
210     * parameter values of current company
211     */
212    public static final String SetParameterXValueList = "setParameterXValueList";
213  
214    /**
215     * arrayList of all parameters of point1(session variable)
216     */
217    public static final String SetParmXValuePoint1 = "setParmXValuePoint1";
218  
219    /**
220     * arrayList of all parameters of point2(session variable)
221     */
222    public static final String SetParmXValuePoint2 = "setParmXValuePoint2";
223  
224    /**
225     * level1CodeTable table (session variable)
226     */
227    public static final String Level1CodeTable = "level1CodeTable";
228  
229    /**
230     * level2CodeTable table (session variable)
231     */
232    public static final String Level2CodeTable = "level2CodeTable";
233  
234  }
235  
236