1    package com.instantbank.lettertemplate.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 August 2002
11    */
12   public interface WebKeys {
13   
14     // KEYS CORRESPONDING TO JAVABEANS WHICH ARE MODEL VIEW
15     // (WEB SESSION VARIABLES):
16   
17     /**
18      * Model view of Job EJB:
19      */
20     public static final String JobModelKey = "jobModel";
21   
22     // KEYS CORRESPONDING TO MODEL EJB REFERENCES
23     // USED BY SERVLETS OUTSIDE MVC (WEB SESSION VARIABLES):
24   
25     /**
26      * Reference to LetterTemplate EJB
27      */
28     public static final String LetterTemplateEJB = "letterTemplateEJB";
29   
30     // KEYS CORRESPONDING TO WEB SESSION VARIABLES
31     // ASSOCIATED TO ENVIRONMENT VARIABLES OF lettertemplate EAR:
32   
33     /**
34      * if it is true, the stacktrace will be shown to user
35      */
36     public static final String ExternalDebugMode = "externalDebugMode";
37   
38     /**
39      * temporal directory in the server machine to upload images from a client machine
40      */
41     public static final String ImagesTemporalPath = "imagesTemporalPath";
42   
43     /**
44      * directory in the server machine with the configuration for rtfToFo
45      */
46     public static final String RtfToFoConfigPath = "rtfToFoConfigPath";
47   
48     /**
49      * Weblogic's Initial Context Factory
50      */
51     public static final String WLInitialContextFactory = "WLInitialContextFactory";
52   
53     /**
54      * Max size for the files generated by letter jobs.
55      */
56     public static final String ZipLettersFileMaxSize = "ZipLettersFileMaxSize";
57   
58     // KEYS CORRESPONDING TO WEB CONTEXT VARIABLES OF CONTROLLER:
59   
60     /**
61      * javaBean for selecting next screen
62      */
63     public static final String ScreenManagerKey = "screenManager";
64   
65     /**
66      * javaBean for processing request user
67      */
68     public static final String RequestProcessorKey = "rp";
69   
70     // KEYS CORRESPONDING TO WEB SESSION VARIABLES OF CONTROLLER:
71   
72     /**
73      * javaBean for sending request event to Service Layer
74      */
75     public static final String WebControllerKey = "webController";
76   
77     /**
78      * javaBean for updating model views in the Application Layer
79      */
80     public static final String ModelManagerKey = "mm";
81   
82     /**
83      * name of next screen to show to the user
84      */
85     public static final String CurrentScreen = "currentScreen";
86   
87     /**
88      * current language
89      */
90     public static final String LanguageKey = "language";
91   
92     /**
93      * list of missing data in the request user
94      */
95     public static final String MissingFormDataKey = "missingFormData";
96   
97     // KEYS CORRESPONDING TO WEB SESSION VARIABLES OBTAINED FROM COLLECTIONS :
98   
99     /**
100     * name of current company
101     */
102    public static final String CompanyName = "companyName";
103  
104    /**
105     * id of current company
106     */
107    public static final String CompanyId = "companyId";
108  
109    /**
110     * version of system
111     */
112    public static final String Version = "version";
113  
114    /**
115     * options of Collections
116     */
117    public static final String OptionCollections = "optionCollections";
118  
119    /**
120     * options of current company
121     */
122    public static final String OptionCompany = "optionCompany";
123  
124    /**
125     * signals an exception in Collections
126     */
127    public static final String HasException = "hasException";
128  
129    /**
130     * current user name
131     */
132    public static final String UserName = "userName";
133  
134    /**
135     * number of current company
136     */
137    public static final String CompanyNumber = "companyNumber";
138  
139    /**
140     * current userid
141     */
142    public static final String UserId = "userId";
143  
144    /**
145     * current usecase
146     */
147    public static final String UseCase = "useCase";
148  
149  
150    // KEYS FOR ANY USECASE:
151    // by default: web request variables:
152  
153    /**
154     * signals that an exception occurred and the text of exception
155     */
156    public static final String ExceptionOcurred = "exceptionOcurred";
157  
158    /**
159     * stacktrace associated to the exception
160     */
161    public static final String ExceptionStackTrace = "exceptionStackTrace";
162  
163    /**
164     * signals that an exception occurred and the text of exception(web session variable)
165     */
166    public static final String ExcOcurred = "excOcurred";
167  
168    /**
169     * stacktrace associated to the exception (web session variable)
170     */
171    public static final String ExcStackTrace = "excStackTrace";
172  
173    /**
174     * main message of the text of exception (until first "." or ":")
175     */
176    public static final String MainMessage = "mainMessage";
177  
178    // KEYS FOR categories USECASE
179    // by default: web request variables:
180  
181    /**
182     * current instance of CategoryEvent
183     */
184    public static final String CategoryEvent = "categoryEvent";
185  
186    /**
187     * categories list of current company
188     */
189    public static final String CategoryList = "categoryList";
190  
191    /**
192     * signals if categories list exists in the web context
193     */
194    public static final String ExistsCategoryList = "existsCategoryList";
195  
196    /**
197     * categories table of all companies (web context variable)
198     */
199    public static final String CategoryTable = "categoryTable";
200  
201    // KEYS FOR ImagesRepository USECASE
202    // by default: web request variables:
203  
204    /**
205     * current instance of ImagesRepositoryEvent
206     */
207    public static final String ImagesRepositoryEvent = "imagesRepositoryEvent";
208  
209    /**
210     * images list of current company
211     */
212    public static final String ImagesRepositoryList = "imagesRepositoryList";
213  
214    /**
215     * signals if images list exists in the web context
216     */
217    public static final String ExistsImagesList = "existsImageList";
218  
219    /**
220     * images table of all companies (web context variable)
221     */
222    public static final String ImageTable = "imageTable";
223  
224    /**
225     * image file name
226     */
227    public static final String ImageFile = "imageFile";
228  
229    /**
230     * bytes of  image (web session variable)
231     */
232    public static final String ImageShow = "imageShow";
233  
234    /**
235     * name of image
236     */
237    public static final String ActionImage = "actionImage";
238  
239    /**
240     * signals if it exists a pending problem to show to user (web session variable)
241     */
242    public static final String PendingProblem = "pendingProblem";
243  
244    // KEYS FOR Templates USECASE
245    // by default: web request variables:
246  
247    /**
248     * current instance of TemplatesEvent
249     */
250    public static final String TemplatesEvent = "templatesEvent";
251  
252    /**
253     * templates list of current company
254     */
255    public static final String TemplatesList = "templatesList";
256  
257    /**
258     * signals if templates list exists in the web context
259     */
260    public static final String ExistsTemplatesList = "existsTemplatesList";
261  
262    /**
263     * templates table of all companies (web context variable)
264     */
265    public static final String TemplatesTable = "templatesTable";
266  
267    /**
268     * name of template
269     */
270    public static final String TemplateName = "templateName";
271  
272    /**
273     * bytes of template pdf (web session variable)
274     */
275    public static final String TemplatesPdf = "templatesPdf";
276  
277    // KEYS FOR INDENPENDENT Components USECASE
278    // by default: web request variables:
279  
280    /**
281     * current instance of ComponentsEvent
282     */
283    public static final String ComponentsEvent = "componentsEvent";
284  
285    /**
286     * components list of current company
287     */
288    public static final String ComponentsList = "componentsList";
289  
290    /**
291     * signals if components list exists in the web context
292     */
293    public static final String ExistsComponentsList = "existsComponentsList";
294  
295    /**
296     * components table of all companies (web context variable)
297     */
298    public static final String ComponentsTable = "componentsTable";
299  
300    // KEYS FOR  PreviewPrint USECASE
301    // by default: web request variables:
302  
303    /**
304     * current instance of PreviewPrintEvent
305     */
306    public static final String PreviewPrintEvent = "previewPrintEvent";
307  
308    // KEYS FOR setLetterJob USECASE
309    // by default: web request variables:
310  
311    /**
312     * current instance of SetLetterJobEvent (web request variable)
313     */
314    public static final String SetLetterJobEvent = "setLetterJobEvent";
315  
316    /**
317     * letter jobs list of current company (web session variable)
318     */
319    public static final String LetterJobsList = "letterJobsList";
320  
321    /**
322     * ftp locations of current company (web session variable)
323     */
324    public static final String LocationsList = "locationsList";
325  
326    /**
327     * data of fields of current company: ArrayList(web session variable)
328     */
329    public static final String CompanyFields = "companyFields";
330  
331    /**
332     * data of fields Id. of current company: long[] (web session variable)
333     */
334    public static final String CompanyFieldsId = "companyFieldsId";
335  
336    /**
337     * system field menus (web session variable)
338     */
339    public static final String FieldMenus = "fieldMenus";
340  
341    /**
342     * letter templates descriptors (web session variable)
343     */
344    public static final String TemplatesDescriptors = "templatesDescriptors";
345  
346    /**
347     * letter template associated to job: template code (web request variable)
348     */
349    public static final String TemplateCode = "templateCode";
350  
351    /**
352     * letter template associated to job: template fields (web request variable)
353     */
354    public static final String TemplateFields = "templateFields";
355  
356    /**
357     * it signals that there is a letter template for a new job
358     *(web request variable)
359     */
360    public static final String NewJobTemplate = "newJobTemplate";
361  
362    /**
363     * body of javaScript method loadFields() (web session variable)
364     */
365    public static final String BodyLoadFields = "bodyLoadFields";
366  
367    /**
368     * body of javaScript method loadMenus() (web session variable)
369     */
370    public static final String BodyLoadMenus = "bodyLoadMenus";
371  
372  
373    // KEYS FOR  BatchStart USECASE :
374  
375    /**
376     * current instance of BatchStartEvent
377     */
378    public static final String BatchStartEvent = "batchStartEvent";
379  
380    /**
381     * letter batch list of current company
382     */
383    public static final String BatchStartList = "batchStartList";
384  
385    /**
386     * batch run (session variable)
387     */
388    public static final String BatchRun = "batchRun";
389  
390    /**
391     * list Jobs list (session variable)
392     */
393    public static final String JobsList = "jobsList";
394  
395    /**
396     * no jobs were selected (session variable)
397     */
398    public static final String NumberOfJobs = "numberOfJobs";
399  
400    // KEYS FOR  BatchReview USECASE :
401  
402    /**
403     * current instance of BatchReviewEvent
404     */
405    public static final String BatchReviewEvent = "batchReviewEvent";
406  
407    /**
408     * letter batch list of current company
409     */
410    public static final String BatchReviewList = "batchReviewList";
411  
412    /**
413     * Hashtable containing company fields information.
414     * Value required by the LetterTemplate intermediate servlet.
415     */
416    public static final String SystemFields = "systemFields";
417  
418  }
419  
420  
421