001 /**
002 * Copyright 2005-2012 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 package org.kuali.rice.kew.api;
017
018 import java.util.HashSet;
019 import java.util.Set;
020
021 /**
022 * This is a constants file used to describe KEW properties
023 *
024 * @author Kuali Rice Team (rice.collab@kuali.org)
025 *
026 */
027 public final class KEWPropertyConstants {
028
029 // Constants used by Document Search and the document search results
030 public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_DOCUMENT_ID = "documentId";
031 public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_DOC_TYPE_LABEL = "docTypeLabel";
032 public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_DOCUMENT_TITLE = "documentTitle";
033 public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_ROUTE_STATUS_DESC = "docRouteStatusCodeDesc";
034 public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_INITIATOR = "initiator";
035 public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_DATE_CREATED = "dateCreated";
036 public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_ROUTE_LOG = "routeLog";
037 public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_DOC_STATUS = "applicationDocumentStatus";
038 public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_STATUS_CODE = "statusCode";
039 public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_INITIATOR_DISPLAY_NAME = "initiatorDisplayName";
040
041 // Constants used by DocumentTypeLookupableHelperServiceImpl
042 public static final String DOCUMENT_TYPE_ID = "documentTypeId";
043 public static final String NAME = "name";
044 public static final String DOC_TYP_LABEL = "label";
045 public static final String DOC_TYPE_PARENT_ID = "documentTypeId";
046 public static final String PARENT_DOC_TYPE_NAME = "parentDocType.name";
047 public static final String ACTIVE = "active";
048 public static final String BACK_LOCATION = "backLocation";
049 public static final String APPLICATION_ID = "applicationId";
050 public static final String DOC_FORM_KEY = "docFormKey";
051
052 //Constants used by RouteNode
053 public static final String ROUTE_NODE_ID = "routeNodeId";
054 public static final String ROUTE_NODE_INSTANCE_ID = "routeNodeInstanceId";
055 public static final String NODE_INSTANCE_ID = "nodeInstanceId";
056 public static final String DOCUMENT_ID = "documentId";
057 public static final String ROUTE_NODE_NAME = "routeNodeName";
058 public static final String PROCESS_ID = "processId";
059 public static final String COMPLETE = "complete";
060 public static final String FINAL_APPROVAL = "finalApprovalInd";
061 public static final String KEY = "key";
062 public static final String ROUTE_NODE_STATE_ID = "nodeStateId";
063
064 // people flow and type
065 public static final String SEQUENCE_NUMBER = "sequenceNumber";
066
067 public static final Set<String> DOC_SEARCH_RESULT_PROPERTY_NAME_SET = new HashSet<String>();
068 static {
069 DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_DOCUMENT_ID);
070 DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_DOC_TYPE_LABEL);
071 DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_DOCUMENT_TITLE);
072 DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_ROUTE_STATUS_DESC);
073 DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_DOC_STATUS);
074 DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_INITIATOR);
075 DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_DATE_CREATED);
076 DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_ROUTE_LOG);
077 }
078
079 // Name of the section in the xml file.
080 public static final String PERSON_RESP_SECTION = "personResponsibilities";
081 // Name of the section in the xml file.
082 public static final String GROUP_RESP_SECTION = "groupResponsibilities";
083 // Name of the section in the xml file.
084 public static final String ROLE_RESP_SECTION = "roleResponsibilities";
085
086 public static final Set<String> RESP_SECTION_NAME_SET = new HashSet<String>();
087 static {
088 RESP_SECTION_NAME_SET.add(PERSON_RESP_SECTION);
089 RESP_SECTION_NAME_SET.add(GROUP_RESP_SECTION);
090 RESP_SECTION_NAME_SET.add(ROLE_RESP_SECTION);
091 }
092
093 private KEWPropertyConstants() {
094 throw new UnsupportedOperationException("do not call");
095 }
096 }