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