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