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