View Javadoc

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