View Javadoc

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