View Javadoc

1   /**
2    * Copyright 2005-2014 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.util;
17  
18  import java.util.ArrayList;
19  import java.util.List;
20  
21  import org.kuali.rice.core.api.CoreConstants;
22  
23  /**
24   * Defines Global Constants for the KRAD Module
25   *
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   */
28  public final class KRADConstants {
29  
30      private KRADConstants() {
31          throw new UnsupportedOperationException("do not call");
32      }
33  
34      public static final String MODULE_NAME = "krad";
35  
36      public static final String KR_MODULE_NAME = "kr";
37  
38      public static final String DEFAULT_ENCODING = "UTF-8";
39  
40      // special user used in the post-processor
41      public static final String SYSTEM_USER = "kr";
42  
43      public static final String KRAD_URL_KEY = "krad.url";
44      public static final String KRAD_INQUIRY_URL_KEY = "krad.inquiry.url";
45      public static final String KRAD_LOOKUP_URL_KEY = "krad.lookup.url";
46      public static final String KRAD_SERVER_LOOKUP_URL_KEY = "rice.server.krad.lookup.url";
47      public static final String KRAD_INITIATED_DOCUMENT_URL_KEY="initiated.document.url";
48      public static final String KRAD_INITIATED_DOCUMENT_VIEW_NAME="InitiatedDocumentView";
49  
50      public static final String KRAD_DICTIONARY_INDEX_POOL_SIZE = "krad.dictionary.indexPoolSize";
51  
52      public static final String PARAM_MAINTENANCE_VIEW_MODE = "maintenanceViewMode";
53      public static final String PARAM_MAINTENANCE_VIEW_MODE_MAINTENANCE = "maintenance";
54      public static final String PARAM_MAINTENANCE_VIEW_MODE_LOOKUP = "lookup";
55      public static final String PARAM_MAINTENANCE_VIEW_MODE_INQUIRY = "inquiry";
56  
57      public static final String KNS_NAMESPACE = "KR-NS";
58      public static final String KRAD_NAMESPACE = "KR-KRAD";
59      public static final String KUALI_RICE_SYSTEM_NAMESPACE = "KR-SYS";
60      public static final String KUALI_RICE_WORKFLOW_NAMESPACE = "KR-WKFLW";
61      public static final String KUALI_RICE_SERVICE_BUS_NAMESPACE = "KR-BUS";
62  
63      public static final String KUALI_ACTION_CAN_EDIT = "canEdit";
64      public static final String KUALI_ACTION_CAN_ANNOTATE = "canAnnotate";
65      public static final String KUALI_ACTION_CAN_CLOSE = "canClose";
66      public static final String KUALI_ACTION_CAN_SAVE = "canSave";
67      public static final String KUALI_ACTION_CAN_ROUTE = "canRoute";
68      public static final String KUALI_ACTION_CAN_CANCEL = "canCancel";
69      public static final String KUALI_ACTION_CAN_RECALL = "canRecall";
70      public static final String KUALI_ACTION_CAN_RELOAD = "canReload";
71      public static final String KUALI_ACTION_CAN_COPY = "canCopy";
72      public static final String KUALI_ACTION_PERFORM_ROUTE_REPORT = "canPerformRouteReport";
73      public static final String KUALI_ACTION_CAN_AD_HOC_ROUTE = "canAdHocRoute";
74      public static final String KUALI_ACTION_CAN_BLANKET_APPROVE = "canBlanketApprove";
75      public static final String KUALI_ACTION_CAN_ACKNOWLEDGE = "canAcknowledge";
76      public static final String KUALI_ACTION_CAN_FYI = "canFYI";
77      public static final String KUALI_ACTION_CAN_APPROVE = "canApprove";
78      public static final String KUALI_ACTION_CAN_DISAPPROVE = "canDisapprove";
79      public static final String KUALI_ACTION_CAN_CREATE = "canCreate";
80      public static final String KUALI_ACTION_CAN_SEND_ADHOC_REQUESTS = "canSendAdHocRequests";
81      public static final String KUALI_ACTION_CAN_ADD_ADHOC_REQUESTS = "canAddAdHocRequests";
82      public static final String KUALI_ACTION_CAN_SEND_NOTE_FYI = "canSendNoteFyi";
83      public static final String KUALI_ACTION_CAN_EDIT_DOCUMENT_OVERVIEW = "canEditDocumentOverview";
84      public static final String KUALI_ACTION_CAN_EXPORT = "canExport";
85      public static final String KUALI_DEFAULT_TRUE_VALUE = "true";
86      public static final String USE_CACHE_ADMINISTRATION_SCREEN = "Use Cache Adminstration Screen";
87      public static final String KUALI_ACTION_CAN_COMPLETE = "canComplete";
88  
89      public static final class DetailTypes {
90          public static final String NA_PARM_DETAIL_TYPE = "N/A";
91          public static final String ALL_DETAIL_TYPE = "All";
92          public static final String LOOKUP_PARM_DETAIL_TYPE = "Lookup";
93          public static final String UNIVERSAL_USER_DETAIL_TYPE = "Person";
94          public static final String KUALI_MODULE_USER_DETAIL_TYPE = "KualiModuleUser";
95          public static final String DOCUMENT_DETAIL_TYPE = "Document";
96          public static final String DOCUMENT_TYPE_DETAIL_TYPE = "DocumentType";
97          public static final String RULE_DETAIL_TYPE = "Rule";
98          public static final String ACTION_LIST_DETAIL_TYPE = "ActionList";
99          public static final String BACKDOOR_DETAIL_TYPE = "Backdoor";
100         public static final String DOCUMENT_SEARCH_DETAIL_TYPE = "DocumentSearch";
101         public static final String EDOC_LITE_DETAIL_TYPE = "EDocLite";
102         public static final String FEATURE_DETAIL_TYPE = "Feature";
103         public static final String GLOBAL_REVIEWER_DETAIL_TYPE = "GlobalReviewer";
104         public static final String MAILER_DETAIL_TYPE = "Mailer";
105         public static final String NOTE_DETAIL_TYPE = "Note";
106         public static final String QUICK_LINK_DETAIL_TYPE = "QuickLink";
107         public static final String ROUTE_QUEUE_DETAIL_TYPE = "RouteQueue";
108         public static final String ROUTE_DETAIL_TYPE = "Route";
109         public static final String RULE_SERVICE_DETAIL_TYPE = "RuleBaseValues";
110         public static final String RULE_TEMPLATE_DETAIL_TYPE = "RuleTemplate";
111         public static final String WORKGROUP_DETAIL_TYPE = "Notification";
112 
113         private DetailTypes() {
114             throw new UnsupportedOperationException("do not call");
115         }
116     }
117 
118     public static final class ParameterNames {
119         public static final String DEFAULT_LOCALE_CODE = "DEFAULT_LOCALE_CODE";
120     }
121 
122     public static final class DocumentFormHeaderFieldIds {
123         public static final String DOCUMENT_NUMBER = "documentNumber";
124         public static final String DOCUMENT_WORKFLOW_STATUS = "documentStatus";
125         public static final String DOCUMENT_INITIATOR = "documentInitiator";
126         public static final String DOCUMENT_CREATE_DATE = "documentCreateDate";
127         public static final String DOCUMENT_TEMPLATE_NUMBER = "documentTemplateNumber";
128 
129         private DocumentFormHeaderFieldIds() {
130             throw new UnsupportedOperationException("do not call");
131         }
132     }
133 
134     public static final String MAX_UPLOAD_SIZE_PARM_NM = "MAX_FILE_SIZE_DEFAULT_UPLOAD";
135 
136     public static final String UPLOADED_FILE_REQUEST_ATTRIBUTE_KEY = "org.kuali.rice.krad.util.WebUtils.uploadedFiles";
137 
138     public static final String NOTE_WORKFLOW_NOTIFICATION_REQUEST_LABEL = "READ NOTES";
139 
140     public static final String SEND_NOTE_WORKFLOW_NOTIFICATION_ACTIONS_PARM_NM =
141             "SEND_NOTE_WORKFLOW_NOTIFICATION_ACTIONS";
142     public static final String ATTACHMENT_MAX_FILE_SIZE_PARM_NM = "MAX_FILE_SIZE_ATTACHMENT";
143     public static final String DOCUMENT_HTTP_SESSION_KEY = "documentHttpSessionKey";
144 
145     //    public static final String CONFIGURATION_FILE_NAME = "configuration";
146     public static final String ENVIRONMENT_KEY = org.kuali.rice.core.api.config.property.Config.ENVIRONMENT;
147     public static final String MESSAGE_RESOURCES = "rice.struts.message.resources";
148     //    public static final String VERSION_KEY = "version";
149     //    public static final String LOG4J_SETTINGS_FILE_KEY = "log4j.settings.file";
150     //    public static final String LOGS_DIRECTORY_KEY = "logs.directory";
151     //    public static final String LOG4J_RELOAD_MINUTES_KEY = "log4j.reload.minutes";
152     //    public static final String STARTUP_STATS_MAILING_LIST_KEY = "startup.stats.mailing.list";
153     public static final String APPLICATION_URL_KEY = "application.url";
154     public static final String ATTACHMENTS_DIRECTORY_KEY = "attachments.directory";
155     public static final String ATTACHMENTS_PENDING_DIRECTORY_KEY = "attachments.pending.directory";
156     //    public static final String HTDOCS_LOGS_URL_KEY = "htdocs.logs.url";
157     //    public static final String HTDOCS_STAGING_URL_KEY = "htdocs.staging.url";
158     public static final String EXTERNALIZABLE_HELP_URL_KEY = "externalizable.help.url";
159     public static final String APPLICATION_EXTERNALIZABLE_IMAGES_URL_KEY = "externalizable.images.url";
160     public static final String EXTERNALIZABLE_IMAGES_URL_KEY = "kr.externalizable.images.url";
161     public static final String ATTACHMENT_IMAGE_PREFIX = "attach.img.";
162     public static final String ATTACHMENT_IMAGE_DEFAULT = "attach.img.default";
163     //    public static final String REPORTS_DIRECTORY_KEY = "reports.directory";
164     public static final String WORKFLOW_URL_KEY = "workflow.url";
165     public static final String KUALI_RICE_URL_KEY = "kr.url";
166     public static final String PROD_ENVIRONMENT_CODE_KEY =
167             org.kuali.rice.core.api.config.property.Config.PROD_ENVIRONMENT_CODE;
168     public static final String DOC_HANDLER_ACTION = "DocHandler.do";
169     public static final String DOCHANDLER_DO_URL = "/" + DOC_HANDLER_ACTION + "?docId=";
170     public static final String DOCHANDLER_URL_CHUNK = "&command=displayDocSearchView";
171     public static final String SUPERUSER_ACTION = "SuperUser.do";
172 
173     //    public static final String DATABASE_REPOSITORY_FILES_LIST_NAME = "databaseRepositoryFilePaths";
174     public static final String SCRIPT_CONFIGURATION_FILES_LIST_NAME = "scriptConfigurationFilePaths";
175     //    public static final String JOB_NAMES_LIST_NAME = "jobNames";
176     //    public static final String TRIGGER_NAMES_LIST_NAME = "triggerNames";
177 
178     public static final String IMAGE_URL_EXPRESSION = "@{#ConfigProperties['krad.externalizable.images.url']}";
179     public static final String DETAILS_IMAGE = "details_open.png";
180 
181     public static final String ACTION_FORM_UTIL_MAP_METHOD_PARM_DELIMITER = "~";
182     public static final String ADD_LINE_METHOD = "addLine";
183     public static final String ADD_PREFIX = "add";
184     public static final String YES_INDICATOR_VALUE = "Y";
185     public static final String NO_INDICATOR_VALUE = "N";
186     //    public static final String AMOUNT_PROPERTY_NAME = "amount";
187     //    public static final String APPROVE_METHOD = "approve";
188     //    public static final String NON_ACTIVE_INDICATOR = "N";
189     public static final String BLANK_SPACE = " ";
190     public static final String BACK_LOCATION = "backLocation";
191     public static final String BACKDOOR_PARAMETER = "backdoorId";
192     public static final String LOGOFF_REDIRECT_URL_PARAMETER = "LOGOFF_REDIRECT_URL";
193     public static final String LOGOFF_REDIRECT_URL_PROPERTY = "rice.portal.logout.redirectUrl";
194     public static final String PORTAL_ALLOWED_REGEX = "rice.portal.allowed.regex";
195     //    public static final String BLANKET_APPROVE_METHOD = "blanketApprove";
196     public static final String BUSINESS_OBJECT_CLASS_ATTRIBUTE = "businessObjectClassName";
197     public static final String DATA_OBJECT_CLASS_ATTRIBUTE = "dataObjectClassName";
198     public static final String CALLING_METHOD = "caller";
199     /**
200      * The {@link org.kuali.rice.kns.question.ConfirmationQuestion} bean
201      */
202     public static final String CONFIRMATION_QUESTION = "confirmationQuestion";
203     /**
204      * The {@link org.kuali.rice.kns.question.RecallQuestion} bean
205      */
206     public static final String RECALL_QUESTION = "recallQuestion";
207     public static final String CONVERSION_FIELDS_PARAMETER = "conversionFields";
208     public static final String FIELDS_CONVERSION_PARAMETER = "fieldConversions";
209     public static final String LOOKUP_READ_ONLY_FIELDS = "readOnlyFields";
210     public static final String LOOKUP_AUTO_SEARCH = "autoSearch";
211     public static final String SEARCH_METHOD = "search";
212     //    public static final String DEFAULT_RETURN_LOCATION = "lookup.do";
213     public static final String DELETE_LINE_METHOD = "deleteLine";
214     public static final String TOGGLE_INACTIVE_METHOD = "toggleInactiveRecordDisplay";
215     public static final String DICTIONARY_BO_NAME = "dictionaryBusinessObjectName";
216     public static final String DISPATCH_REQUEST_PARAMETER = "methodToCall";
217 
218     /**
219      * Constant defined to match with method call in module-locked.jsp which is
220      * set to a message that is displayed when the module is locked.
221      */
222     public static final String MODULE_LOCKED_MESSAGE_REQUEST_PARAMETER = "moduleLockedMessage";
223 
224     public static final String CUSTOM_ACTION = "customAction";
225     public static final String DOC_FORM_KEY = "docFormKey";
226     public static final String FORM_KEY = "formKey";
227     public static final String NEW_NOTE_NOTE_TYPE_CODE = "newNote.noteTypeCode";
228     public static final String POST_TEXT_AREA_TO_PARENT = "postTextAreaToParent";
229     public static final String DOCUMENT_CANCEL_QUESTION = "DocCancel";
230     //    public static final String DOCUMENT_DELETE_QUESTION = "DocDelete";
231     public static final String DOCUMENT_DISAPPROVE_QUESTION = "DocDisapprove";
232     public static final String DOCUMENT_RECALL_QUESTION = "DocRecall";
233     public static final String DOCUMENT_SENSITIVE_DATA_QUESTION = "DocSensitiveDataQuestion";
234     //    public static final String DOCUMENT_HEADER_ID = "documentHeaderId";
235     public static final String DOCUMENT_HEADER_PROPERTY_NAME = "documentHeader";
236     public static final String DOCUMENT_SAVE_BEFORE_CLOSE_QUESTION = "DocSaveBeforeClose";
237     public static final String EXTRA_BUTTON_SOURCE = "extraButtonSource";
238     public static final String EXTRA_BUTTON_PARAMS = "extraButtonParams";
239     public static final String ADVANCED_SEARCH_FIELD = "isAdvancedSearch";
240     public static final String NEW_AD_HOC_ROUTE_PERSON_PROPERTY_NAME = "newAdHocRoutePerson";
241     public static final String NEW_AD_HOC_ROUTE_WORKGROUP_PROPERTY_NAME = "newAdHocRouteWorkgroup";
242     public static final String EXISTING_AD_HOC_ROUTE_PERSON_PROPERTY_NAME = "adHocRoutePerson";
243     public static final String EXISTING_AD_HOC_ROUTE_WORKGROUP_PROPERTY_NAME = "adHocRouteWorkgroup";
244     public static final String DOCUMENT_PROPERTY_NAME = "document";
245     public static final String DOCUMENT_TYPE_NAME = "docTypeName";
246     public static final String EDIT_PREFIX = "edit";
247     public static final String EMPTY_STRING = CoreConstants.EMPTY_STRING;
248     public static final String FIELD_CONVERSION_PAIR_SEPARATOR = ":";
249     public static final String FIELD_CONVERSIONS_SEPARATOR = ",";
250     public static final String REFERENCES_TO_REFRESH_SEPARATOR = ",";
251     public static final String RESTRICTED_DATA_MASK = "xxxxxx";
252     //    public static final String GENERIC_FIELD_NAME = "Field";
253     //    public static final String GENERIC_CODE_PROPERTY_NAME = "code";
254     //    public static final String STAND_IN_BUSINESS_OBJECT_FOR_ATTRIBUTES = "AttributeReferenceDummy";
255     public static final String OVERRIDE_KEYS = "overrideKeys";
256     public static final String COPY_KEYS = "cpKys";
257 
258     public static final String KRAD_APPLICATION_DATASOURCE = "kradApplication.datasource";
259     public static final String KRAD_APPLICATION_DATASOURCE_JNDI = "kradApplication.datasource.jndi.location";
260 
261     // **************** Begin Note & Attachments defines
262     /**
263      * Property name for notes collection
264      */
265     public static final String NOTES_PROPERTY_NAME = "notes";
266     /**
267      * Property name for new document - Value is "newNote"
268      */
269     public static final String NEW_DOCUMENT_NOTE_PROPERTY_NAME = "newNote";
270     /**
271      * Property name for note text - Value is "noteText"
272      */
273     public static final String NOTE_TEXT_PROPERTY_NAME = "noteText";
274     /**
275      * Property name for note topic text - Value is "noteTopicText"
276      */
277     public static final String NOTE_TOPIC_TEXT_PROPERTY_NAME = "noteTopicText";
278     /**
279      * Property name for note attachment - Value is "attachmentFile"
280      */
281     public static final String NOTE_ATTACHMENT_FILE_PROPERTY_NAME = "attachmentFile";
282 
283     /**
284      * Property name for enabling attachments to note, overriding the defaults defined by the document template - Value
285      * is
286      * "enableNoteAttachments"
287      * <p>
288      * Example: The following line defined in the application properties file
289      * <p>
290      * enableNoteAttachments=false
291      * <p>
292      * disables the attachment option in Notes & Attachment of a document
293      */
294     public static final String NOTE_ATTACHMENT_ENABLED = "enableNoteAttachments";
295     // **************** End Note & Attachments defines
296 
297     /**
298      * This value is the name of the param for the default max column length of a lookup result field if the field
299      * maxLength
300      * has not been defined in the DD
301      */
302     public static final String RESULTS_DEFAULT_MAX_COLUMN_LENGTH = "RESULTS_DEFAULT_MAX_COLUMN_LENGTH";
303 
304     //    /**
305     //     * The number of levels BusinessObjectDictionaryServiceImpl will recurse. If this number is high, it may lead to serious
306     //     * performance problems
307     //     */
308     //    public static final int BUSINESS_OBJECT_DICTIONARY_SERVICE_PERFORM_FORCE_UPPERCASE_RECURSION_MAX_DEPTH = 3;
309 
310     /**
311      * When checkboxes are rendered on the form, a hidden field will also be rendered corresponding to each checkbox
312      * with the
313      * checkbox's name suffixed with the value of this constant. No real fields should have names that contain this
314      * suffix,
315      * since this may lead to undesired results.
316      */
317     public static final String CHECKBOX_PRESENT_ON_FORM_ANNOTATION = "{CheckboxPresentOnFormAnnotation}";
318 
319     public static final int DOCUMENT_ANNOTATION_MAX_LENGTH = 2000;
320 
321     public static final String HIDE_LOOKUP_RETURN_LINK = "hideReturnLink";
322     public static final String SUPPRESS_ACTIONS = "suppressActions";
323     public static final String REFERENCES_TO_REFRESH = "referencesToRefresh";
324 
325     public static final String INQUIRABLE_ATTRIBUTE_NAME = "kualiInquirable";
326     public static final String INQUIRY_ACTION = "inquiry.do";
327     public static final String PORTAL_ACTION = "portal.do";
328     public static final String DIRECT_INQUIRY_ACTION = "directInquiry.do";
329     public static final String CONTINUE_WITH_INQUIRY_METHOD_TO_CALL = "continueWithInquiry";
330     public static final String INQUIRY_PK_VALUE_PASSED_FROM_PREVIOUS_REQUEST_PREFIX = "previousPkValue_";
331     public static final String INACTIVE_RECORD_DISPLAY_PARAM_PREFIX = "inactiveRecordDisplay_";
332 
333     public static final String FIELD_NAME_TO_FOCUS_ON_AFTER_SUBMIT = "fieldNameToFocusOnAfterSubmit";
334 
335     public static final String DEFAULT_PARAMETER_APPLICATION_ID = "KUALI";
336     public static final String DEFAULT_NAMESPACE = "KUALI";
337     public static final String LOOKUP_ACTION = "lookup.do";
338     public static final String MULTIPLE_VALUE_LOOKUP_ACTION = "multipleValueLookup.do";
339     public static final String LOOKUP_RESULTS_SEQUENCE_NUMBER = "lookupResultsSequenceNumber";
340     public static final String LOOKUP_RESULTS_BO_CLASS_NAME = "lookupResultsBOClassName";
341     public static final String LOOKED_UP_COLLECTION_NAME = "lookedUpCollectionName";
342     public static final String MULTIPLE_VALUE_LOOKUP_PREVIOUSLY_SELECTED_OBJ_IDS_PARAM = "previouslySelectedObjectIds";
343     public static final String MULTIPLE_VALUE_LOOKUP_OBJ_IDS_SEPARATOR = "||";
344     public static final String MULTIPLE_VALUE_LOOKUP_DISPLAYED_OBJ_ID_PARAM_PREFIX = "displayedObjId-";
345     public static final String MULTIPLE_VALUE_LOOKUP_SELECTED_OBJ_ID_PARAM_PREFIX = "selectedObjId-";
346     public static final String LOOKUP_ANCHOR = "lookupAnchor";
347     public static final String LOOKUPABLE_IMPL_ATTRIBUTE_NAME = "lookupableImplServiceName";
348     public static final String LOOKUP_RESULTS_SEQUENCE = "KRNS_LOOKUP_RSLT_S";
349     public static final String KUALI_LOOKUPABLE_IMPL = "kualiLookupable";
350     public static final String PARAMETER_DOC_ID = "docId";
351     public static final String PARAMETER_COMMAND = "command";
352     public static final String ACTION_CLASS = "actionClass";
353     public static final String NAMESPACE_CODE = "namespaceCode";
354     public static final String COMPONENT_NAME = "componentName";
355     //    public static final String LOOKUP_METHOD = "performLookup";
356     public static final String LOOKUP_DEFAULT_RANGE_SEARCH_LOWER_BOUND_LABEL = "From";
357     public static final String LOOKUP_DEFAULT_RANGE_SEARCH_UPPER_BOUND_LABEL = "To";
358     public static final String LOOKUP_RANGE_LOWER_BOUND_PROPERTY_PREFIX = "rangeLowerBoundKeyPrefix_";
359     public static final String LOOKUP_RANGE_UPPER_BOUND_PROPERTY_PREFIX = "rangeUpperBoundKeyPrefix_";
360     public static final String LOOKUP_PARAMETER_LITERAL_PREFIX = "literal";
361     public static final String LOOKUP_PARAMETER_LITERAL_DELIMITER = "=";
362 
363     public static final String METHOD_DISPLAY_DOC_SEARCH_VIEW = "displayDocSearchView";
364     public static final String MAINTENANCE_ACTION = "maintenance.do";
365     public static final String MAINTENANCE_ADD_PREFIX = "add.";
366     public static final String MAINTENANCE_COPY_ACTION = "Copy";
367     public static final String MAINTENANCE_EDIT_ACTION = "Edit";
368     public static final String MAINTENANCE_DELETE_ACTION = "Delete";
369     public static final String MAINTENANCE_NEW_ACTION = "New";
370     public static final String MAINTENANCE_COPY_METHOD_TO_CALL = "copy";
371     public static final String MAINTENANCE_EDIT_METHOD_TO_CALL = "edit";
372     public static final String MAINTENANCE_DELETE_METHOD_TO_CALL = "delete";
373     public static final String MAINTENANCE_NEW_METHOD_TO_CALL = "start";
374     public static final String MAINTENANCE_NEWWITHEXISTING_ACTION = "newWithExisting";
375     public static final String MAINTENANCE_ACTN = "maintenanceAction";
376     public static final String MAINTENANCE_NEW_MAINTAINABLE = "document.newMaintainableObject.";
377     public static final String MAINTENANCE_OLD_MAINTAINABLE = "document.oldMaintainableObject.";
378     public static final String MAPPING_CANCEL = "cancel";
379     public static final String MAPPING_RECALL = "recall";
380     public static final String MAPPING_CLOSE = "close";
381     public static final String MAPPING_DISAPPROVE = "disapprove";
382     //    public static final String MAPPING_DELETE = "delete";
383     // Activate the MAPPING_ERROR define for use in Exception incident and handling
384     public static final String MAPPING_ERROR = "error";
385     public static final String MAPPING_PORTAL = "portal";
386     //    public static final String MAPPING_MULTIPLE_VALUE_LOOKUP = "multipleValueLookup";
387     public static final String MAPPING_ROUTE_REPORT = "route_report";
388     //    public static final String MAXLENGTH_SUFFIX = ".maxLength";
389     public static final String METHOD_TO_CALL_ATTRIBUTE = "methodToCallAttribute";
390     public static final String METHOD_TO_CALL_PATH = "methodToCallPath";
391     public static final String METHOD_TO_CALL_BOPARM_LEFT_DEL = "(!!";
392     public static final String METHOD_TO_CALL_BOPARM_RIGHT_DEL = "!!)";
393     public static final String METHOD_TO_CALL_PARM1_LEFT_DEL = "(((";
394     public static final String METHOD_TO_CALL_PARM1_RIGHT_DEL = ")))";
395     public static final String METHOD_TO_CALL_PARM2_LEFT_DEL = "((`";
396     public static final String METHOD_TO_CALL_PARM2_RIGHT_DEL = "`))";
397     public static final String METHOD_TO_CALL_PARM3_LEFT_DEL = "((<";
398     public static final String METHOD_TO_CALL_PARM3_RIGHT_DEL = ">))";
399     public static final String METHOD_TO_CALL_PARM4_LEFT_DEL = "(([";
400     public static final String METHOD_TO_CALL_PARM4_RIGHT_DEL = "]))";
401     public static final String METHOD_TO_CALL_PARM5_LEFT_DEL = "((*";
402     public static final String METHOD_TO_CALL_PARM5_RIGHT_DEL = "*))";
403     public static final String METHOD_TO_CALL_PARM6_LEFT_DEL = "((%";
404     public static final String METHOD_TO_CALL_PARM6_RIGHT_DEL = "%))";
405     public static final String METHOD_TO_CALL_PARM7_LEFT_DEL = "((^";
406     public static final String METHOD_TO_CALL_PARM7_RIGHT_DEL = "^))";
407     public static final String METHOD_TO_CALL_PARM8_LEFT_DEL = "((&";
408     public static final String METHOD_TO_CALL_PARM8_RIGHT_DEL = "&))";
409     public static final String METHOD_TO_CALL_PARM9_LEFT_DEL = "((~";
410     public static final String METHOD_TO_CALL_PARM9_RIGHT_DEL = "~))";
411     public static final String METHOD_TO_CALL_PARM10_LEFT_DEL = "((/";
412     public static final String METHOD_TO_CALL_PARM10_RIGHT_DEL = "/))";
413     public static final String METHOD_TO_CALL_PARM11_LEFT_DEL = "(:;";
414     public static final String METHOD_TO_CALL_PARM11_RIGHT_DEL = ";:)";
415     public static final String METHOD_TO_CALL_PARM12_LEFT_DEL = "(::;";
416     public static final String METHOD_TO_CALL_PARM12_RIGHT_DEL = ";::)";
417     // below 2 fields used in rowDisplay.tag file
418     public static final String METHOD_TO_CALL_PARM13_LEFT_DEL = "(:::;";
419     public static final String METHOD_TO_CALL_PARM13_RIGHT_DEL = ";:::)";
420     // used for baseLookupURL
421     public static final String METHOD_TO_CALL_PARM14_LEFT_DEL = "(::::;";
422     public static final String METHOD_TO_CALL_PARM14_RIGHT_DEL = ";::::)";
423     // if more strings needed, then add more colons to the PARM11 strings above, e.g. (::; (:::;, etc.
424 
425     // Pessimistic Locking Constants
426     public static final String SESSION_TIMEOUT_WARNING_MESSAGE_TIME_PARM_NM = "SESSION_TIMEOUT_WARNING_MESSAGE_TIME";
427     public static final String SESSION_TIMEOUT_WARNING_MILLISECONDS = "SESSION_TIMEOUT_WARNING_MILLISECONDS";
428     public static final String SESSION_TIMEOUT_WARNING_MINUTES = "SESSION_TIMEOUT_WARNING_MINUTES";
429 
430     public static final String ANCHOR = "anchor";
431     public static final String ANCHOR_TOP_OF_FORM = "topOfForm";
432     public static final String QUESTION_ANCHOR = "questionAnchor";
433     public static final String NOT_AVAILABLE_STRING = "N/A";
434     public static final String QUESTION_ACTION = "questionPrompt.do";
435     public static final String QUESTION_CLICKED_BUTTON = "buttonClicked";
436     public static final String QUESTION_ERROR_KEY = "questionErrorKey";
437     public static final String QUESTION_ERROR_PROPERTY_NAME = "questionErrorPropertyName";
438     public static final String QUESTION_ERROR_PARAMETER = "questionErrorParameter";
439     public static final String QUESTION_IMPL_ATTRIBUTE_NAME = "questionType";
440     public static final String QUESTION_INST_ATTRIBUTE_NAME = "questionIndex";
441     public static final String QUESTION_PAGE_TITLE = "Question Dialog Page";
442     public static final String QUESTION_REFRESH = "QuestionRefresh";
443     public static final String QUESTION_CONTEXT = "context";
444     public static final String QUESTION_TEXT_ATTRIBUTE_NAME = "questionText";
445     public static final String QUESTION_REASON_ATTRIBUTE_NAME = "reason";
446     public static final String QUESTION_SHOW_REASON_FIELD = "showReasonField";
447 
448     public static final String REFRESH_CALLER = "refreshCaller";
449     public static final String REFRESH_CALLER_TYPE = "refreshCallerType";
450     public static final String REFRESH_DATA_OBJECT_CLASS = "refreshDataObjectClass";
451     public static final String REFRESH_MAPPING_PREFIX = "/Refresh";
452 
453     // below field used in tag files
454     public static final String REQUIRED_FIELD_SYMBOL = "*";
455     public static final String RETURN_LOCATION_PARAMETER = "returnLocation";
456     public static final String RETURN_METHOD_TO_CALL = "refresh";
457     // Another possible value for the "refreshCaller" request parameter, as a fix for KULRICE-2903.
458     public static final String TEXT_AREA_REFRESH = "TextAreaRefresh";
459     // below field used in tag files
460 
461     // KualiDocumentActionBase Method Names
462     public static final String ROUTE_METHOD = "route";
463     public static final String SAVE_METHOD = "save";
464     public static final String APPROVE_METHOD = "approve";
465     public static final String BLANKET_APPROVE_METHOD = "blanketApprove";
466     public static final String DOC_HANDLER_METHOD = "docHandler";
467     public static final String CLOSE_METHOD = "close";
468     public static final String CANCEL_METHOD = "cancel";
469     public static final String LOAD_DOCUMENT_METHOD = "loadDocument";
470     public static final String CREATE_DOCUMENT_METHOD = "createDocument";
471     public static final String DISAPPROVE_METHOD = "disapprove";
472     public static final String FYI_METHOD = "fyi";
473     public static final String ACKNOWLEDGE_METHOD = "acknowledge";
474 
475     public static final String DOWNLOAD_BO_ATTACHMENT_METHOD = "downloadBOAttachment";
476     public static final String DOWNLOAD_CUSTOM_BO_ATTACHMENT_METHOD = "downloadCustomBOAttachment";
477     public static final String NOTE_IDENTIFIER = "noteIdentifier";
478     public static final String BO_ATTACHMENT_FILE_NAME = "fileName";
479     public static final String BO_ATTACHMENT_FILE_CONTENT_TYPE = "contentType";
480     public static final String BO_ATTACHMENT_FILE_CONTENT_FIELD = "fileContentBOField";
481 
482     // specialized method 'delete' used only for PessimisticLocks currently
483     public static final String DELETE_METHOD = "delete";
484     public static final String START_METHOD = "start";
485     public static final String USER_SESSION_KEY = "UserSession";
486     public static final String KUALI_SESSION_ID = "kualiSessionId";
487     public static final String EXITING_DOCUMENT = "exitingDocument";
488     public static final String DOCUMENT_DOCUMENT_NUMBER = "document.documentNumber";
489     public static final String DOC_NUM = "docNum";
490 
491     public static final String SEARCH_LIST_KEY_PREFIX = "searchResults";
492     public static final String SEARCH_LIST_REQUEST_KEY = "searchResultKey";
493 
494     public static final String METHOD_DISPLAY_ALL_INACTIVATION_BLOCKERS = "displayAllInactivationBlockers";
495     public static final String DISPLAY_ALL_INACTIVATION_BLOCKERS_ACTION = "inactivationBlockers.do";
496 
497     public static final String GLOBAL_ERRORS = "GLOBAL_ERRORS";
498     // TODO: fix this constant to be GLOBAL_MESSAGES once KNS is removed
499     public static final String GLOBAL_MESSAGES = "GlobalMessages";
500     public static final String GLOBAL_INFO = "GLOBAL_INFO";
501     public static final String PESSIMISTIC_LOCK_MESSAGES = "DocumentPessimisticLockMessages";
502     public static final String AD_HOC_ROUTE_PERSON_ERRORS = "newAdHocRoutePerson*,adHocRoutePerson*";
503     public static final String AD_HOC_ROUTE_WORKGROUP_ERRORS = "newAdHocRouteWorkgroup*,adHocRouteWorkgroup*";
504     public static final String AD_HOC_ROUTE_ERRORS = AD_HOC_ROUTE_PERSON_ERRORS + "," + AD_HOC_ROUTE_WORKGROUP_ERRORS;
505     public static final String DOCUMENT_DOCUMENT_ERRORS = "document.document*";
506     public static final String DOCUMENT_EXPLANATION_ERRORS = "document.explanation*";
507     public static final String DOCUMENT_REVERSAL_ERRORS = "document.reversal*";
508     public static final String DOCUMENT_SELECTED_ERRORS = "document.selected*";
509     public static final String DOCUMENT_HEADER_ERRORS = "document.header*";
510     //    public static final String DOCUMENT_ERRORS_LESS_DOCUMENT = DOCUMENT_EXPLANATION_ERRORS + "," + DOCUMENT_REVERSAL_ERRORS + "," + DOCUMENT_SELECTED_ERRORS + "," + DOCUMENT_HEADER_ERRORS;
511     public static final String DOCUMENT_ERRORS = DOCUMENT_DOCUMENT_ERRORS +
512             "," +
513             DOCUMENT_EXPLANATION_ERRORS +
514             "," +
515             DOCUMENT_REVERSAL_ERRORS +
516             "," +
517             DOCUMENT_SELECTED_ERRORS +
518             "," +
519             DOCUMENT_HEADER_ERRORS;
520     // below field used in tag files
521     public static final String DOCUMENT_NOTES_ERRORS = NEW_DOCUMENT_NOTE_PROPERTY_NAME + "*";
522 
523     // export formats
524 
525     public static final String XML_FORMAT = "xml";
526     public static final String EXCEL_FORMAT = "xls";
527     public static final String CSV_FORMAT = "csv";
528 
529     public static final String XML_MIME_TYPE = "application/xml";
530 
531     // Header Tab navigation constant values
532     public static final String NAVIGATE_TO = "navigateTo.";
533     public static final String HEADER_DISPATCH = "headerDispatch.";
534 
535     public static final String MULTIPLE_VALUE = "multipleValues";
536 
537     // Agency type codes
538     //    public static final String AGENCY_TYPE_CODE_FEDERAL = "F";
539 
540     // special chars that I don't know how to put into string literals in JSP expression language
541     // below field used in tag files
542     public static final String NEWLINE = "\n";
543 
544     // websession
545     public static final String DOCUMENT_WEB_SCOPE = "documentWebScope";
546     public static final String SESSION_SCOPE = "session";
547 
548     public static final class SystemGroupParameterNames {
549         public static final String CHECK_ENCRYPTION_SERVICE_OVERRIDE_IND = "CHECK_ENCRYPTION_SERVICE_OVERRIDE_IND";
550 
551         public static final String LOOKUP_RESULTS_LIMIT = "RESULTS_LIMIT";
552         public static final String MULTIPLE_VALUE_LOOKUP_RESULTS_PER_PAGE = "MULTIPLE_VALUE_RESULTS_PER_PAGE";
553         //        public static final String MULTIPLE_VALUE_LOOKUP_RESULTS_EXPIRATION_AGE = "MULTIPLE_VALUE_RESULTS_EXPIRATION_SECONDS";
554 
555         public static final String DEFAULT_CAN_PERFORM_ROUTE_REPORT_IND = "DEFAULT_CAN_PERFORM_ROUTE_REPORT_IND";
556         public static final String ALLOW_ENROUTE_BLANKET_APPROVE_WITHOUT_APPROVAL_REQUEST_IND =
557                 "ALLOW_ENROUTE_BLANKET_APPROVE_WITHOUT_APPROVAL_REQUEST_IND";
558         /**
559          * Used to indicate whether field level help is enabled. Depending on the namespace this parameter is in, it
560          * may
561          * affect either lookups (i.e. the search criteria fields) or maintenance documents.
562          */
563         public static final String ENABLE_FIELD_LEVEL_HELP_IND = "ENABLE_FIELD_LEVEL_HELP_IND";
564 
565         //        /**
566         //         * Used by PurgePendingAttachmentsJob to compute the maximum amount of time a pending attachment is allowed to
567         //         * persist on the file system before being deleted.
568         //         */
569         //        public static final String PURGE_PENDING_ATTACHMENTS_STEP_MAX_AGE = "purgePendingAttachmentsStepMaxAge";
570 
571         public static final String ENABLE_DIRECT_INQUIRIES_IND = "ENABLE_DIRECT_INQUIRIES_IND";
572         public static final String DEFAULT_COUNTRY = "DEFAULT_COUNTRY";
573 
574         public static final String SENSITIVE_DATA_PATTERNS = "SENSITIVE_DATA_PATTERNS";
575         public static final String SENSITIVE_DATA_PATTERNS_WARNING_IND = "SENSITIVE_DATA_PATTERNS_WARNING_IND";
576 
577         public static final String OLTP_LOCKOUT_ACTIVE_IND = "OLTP_LOCKOUT_ACTIVE_IND";
578         public static final String OLTP_LOCKOUT_MESSAGE_PARM = "OLTP_LOCKOUT_MESSAGE";
579         public static final String OLTP_LOCKOUT_DEFAULT_MESSAGE = "OLTP_LOCKOUT_DEFAULT_MESSAGE";
580 
581         private SystemGroupParameterNames() {
582             throw new UnsupportedOperationException("do not call");
583         }
584     }
585 
586     public static final int DEFAULT_NUM_OF_COLUMNS = 1;
587 
588     public static final class TableRenderConstants {
589         public static final String SWITCH_TO_PAGE_METHOD = "switchToPage";
590         public static final String SORT_METHOD = "sort";
591         public static final String SELECT_ALL_METHOD = "selectAll";
592         public static final String UNSELECT_ALL_METHOD = "unselectAll";
593 
594         // below field used on displayMultipleValueLookupResults.tag
595         public static final String PREVIOUSLY_SORTED_COLUMN_INDEX_PARAM = "previouslySortedColumnIndex";
596         public static final String VIEWED_PAGE_NUMBER = "viewedPageNumber";
597 
598         private TableRenderConstants() {
599             throw new UnsupportedOperationException("do not call");
600         }
601     }
602 
603     public static final String TAB_STATES = "tabStates";
604 
605     public static final List<String> ALWAYS_VALID_PARAMETER_PREFIXES = new ArrayList<String>();
606 
607     static {
608         ALWAYS_VALID_PARAMETER_PREFIXES.add(TAB_STATES);
609         ALWAYS_VALID_PARAMETER_PREFIXES.add(DISPATCH_REQUEST_PARAMETER + ".hideAllTabs");
610         ALWAYS_VALID_PARAMETER_PREFIXES.add(DISPATCH_REQUEST_PARAMETER + ".showAllTabs");
611         ALWAYS_VALID_PARAMETER_PREFIXES.add(DISPATCH_REQUEST_PARAMETER + ".toggleTab");
612         ALWAYS_VALID_PARAMETER_PREFIXES.add(
613                 DISPATCH_REQUEST_PARAMETER + "." + TableRenderConstants.SWITCH_TO_PAGE_METHOD);
614         ALWAYS_VALID_PARAMETER_PREFIXES.add(DISPATCH_REQUEST_PARAMETER + "." + TableRenderConstants.SORT_METHOD);
615     }
616 
617     public static final String GLOBAL_VARIABLES_MESSAGES_LIST_ACTION_MESSAGES = "GlobalVariablesMessagesList";
618 
619     public static final class Config {
620         public static final String APPLY_ILLEGAL_BUSINESS_OBJECT_FOR_SAVE_CHECK =
621                 "rice.krad.illegalBusinessObjectsForSave.applyCheck";
622         public static final String ILLEGAL_BUSINESS_OBJECTS_FOR_SAVE = "rice.krad.illegalBusinessObjectsForSave";
623         public static final String COMPONENT_PUBLISHING_ENABLED = "rice.krad.componentPublishing.enabled";
624         public static final String COMPONENT_PUBLISHING_DELAY = "rice.krad.componentPublishing.delay";
625         public static final String IGNORE_MISSIONG_FIELDS_ON_DESERIALIZE = "rice.krad.bos.ignoreMissingFieldsOnDeserialize";
626 
627         private Config() {
628             throw new UnsupportedOperationException("do not call");
629         }
630     }
631 
632     public static final String ENABLE_NONPRODUCTION_UNMASKING = "enable.nonproduction.data.unmasking";
633 
634     public static final String SINGLE_QUOTE = "'";
635 
636     public static final String SENSITIVE_DATA_QUESTION_SESSION_TICKET = "SENSITIVE_DATA_QUESTION_SESSION_TICKET";
637     public static final String EDITABLE_PROPERTIES_HISTORY_HOLDER_ATTR_NAME = "EditablePropertiesHistoryHolder";
638 
639     // TODO: new krad constants, previous needs to be cleaned up
640     public static final String DATA_TYPE_STRING = CoreConstants.DATA_TYPE_STRING;
641     public static final String DATA_TYPE_DATE = CoreConstants.DATA_TYPE_DATE;
642     public static final String DATA_TYPE_LONG = CoreConstants.DATA_TYPE_LONG;
643     public static final String DATA_TYPE_FLOAT = CoreConstants.DATA_TYPE_FLOAT;
644     public static final String DATA_TYPE_BOOLEAN = CoreConstants.DATA_TYPE_BOOLEAN;
645 
646     public static final String ACTIONS_COLUMN_TITLE = "Actions";
647 
648     public static final class Maintenance {
649         public static final String REQUEST_MAPPING_MAINTENANCE = "maintenance";
650         public static final String METHOD_TO_CALL_NEW = "start";
651         public static final String METHOD_TO_CALL_NEW_WITH_EXISTING = "maintenanceNewWithExisting";
652         public static final String METHOD_TO_CALL_EDIT = "maintenanceEdit";
653         public static final String METHOD_TO_CALL_COPY = "maintenanceCopy";
654         public static final String METHOD_TO_CALL_DELETE = "maintenanceDelete";
655         public static final String LOCK_AFTER_CLASS_DELIM = "!!";
656         public static final String LOCK_AFTER_FIELDNAME_DELIM = "^^";
657         public static final String LOCK_AFTER_VALUE_DELIM = "::";
658     }
659 
660     public static class Lookup {
661         public static final String TITLE_RETURN_URL_PREPENDTEXT_PROPERTY = "title.return.url.value.prependtext";
662         public static final String TITLE_ACTION_URL_PREPENDTEXT_PROPERTY = "title.action.url.value.prependtext";
663     }
664 
665     public static final class MessageParsing {
666         public static final String LEFT_TOKEN = "[";
667         public static final String RIGHT_TOKEN = "]";
668         public static final String RIGHT_TOKEN_MARKER = "$@$";
669         public static final String RIGHT_TOKEN_PLACEHOLDER = RIGHT_TOKEN_MARKER + RIGHT_TOKEN;
670         public static final String LEFT_BRACKET = "&#91;";
671         public static final String RIGHT_BRACKET = "&#93;";
672         public static final String INLINE_COMP_CLASS = "inlineBlock";
673         public static final String COMPONENT_BY_ID = "id";
674         public static final String COLOR = "color";
675         public static final String CSS_CLASSES = "css";
676         public static final String ACTION_LINK = "action";
677         public static final String ACTION_DATA = "data";
678         public static final String LINK = "link";
679         public static final String[] UNALLOWED_HTML =
680                 {"script", "link", "iframe", "html", "head", "body", "object", "form", "frame", "frameset", "!DOCTYPE"};
681     }
682 
683     public static final String DICTIONARY_BEAN_PARENT_SUFFIX = "-parentBean";
684     public static final String EXPRESSION_MESSAGE_PLACEHOLDER_PREFIX = "#msg(";
685     public static final String EXPRESSION_MESSAGE_PLACEHOLDER_SUFFIX = ")";
686     public static final String MESSAGE_KEY_PLACEHOLDER_PREFIX = "@msg{";
687     public static final String MESSAGE_KEY_PLACEHOLDER_SUFFIX = "}";
688     public static final String MESSAGE_KEY_PATH_INDICATOR = "#";
689 
690     public static final String QUOTE_PLACEHOLDER = "@quot@";
691 
692     public static final String REQUEST_MAPPING_SESSION_TIMEOUT = "sessionTimout";
693     public static final String SESSION_TIMEOUT_VIEW_ID = "Uif-SessionTimeoutView";
694 
695     public static final class ConfigParameters {
696         public static final String APPLICATION_VERSION = "application.version";
697         public static final String APPLICATION_URL = "application.url";
698         public static final String KRAD_DEV_MODE = "rice.krad.dev.mode";
699     }
700 }