View Javadoc

1   /**
2    * Copyright 2005-2012 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.kew.api;
17  
18  import java.util.HashSet;
19  import java.util.Set;
20  
21  /**
22   * This is a constants file used to describe KEW properties
23   *
24   * @author Kuali Rice Team (rice.collab@kuali.org)
25   *
26   */
27  public final class KEWPropertyConstants {
28  
29      // Constants used by Document Search and the document search results
30      public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_DOCUMENT_ID = "documentId";
31      public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_DOC_TYPE_LABEL = "docTypeLabel";
32      public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_DOCUMENT_TITLE = "documentTitle";
33      public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_ROUTE_STATUS_DESC = "docRouteStatusCodeDesc";
34      public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_INITIATOR = "initiator";
35      public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_DATE_CREATED = "dateCreated";
36      public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_ROUTE_LOG = "routeLog";
37      public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_DOC_STATUS = "appDocStatus";
38      public static final String DOC_SEARCH_RESULT_PROPERTY_NAME_STATUS_CODE = "statusCode";
39  
40      
41      // Constants used by DocumentTypeLookupableHelperServiceImpl
42      public static final String DOCUMENT_TYPE_ID = "documentTypeId";
43      public static final String NAME = "name";
44      public static final String DOC_TYP_LABEL = "label";
45      public static final String DOC_TYPE_PARENT_ID = "documentTypeId";
46      public static final String PARENT_DOC_TYPE_NAME = "parentDocType.name";
47      public static final String ACTIVE = "active";
48      public static final String BACK_LOCATION = "backLocation";
49      public static final String APPLICATION_ID = "applicationId";
50      public static final String DOC_FORM_KEY = "docFormKey";
51  
52      //Constants used by RouteNode
53      public static final String ROUTE_NODE_ID = "routeNodeId";
54      public static final String ROUTE_NODE_INSTANCE_ID = "routeNodeInstanceId";
55      public static final String NODE_INSTANCE_ID = "nodeInstanceId";
56      public static final String DOCUMENT_ID = "documentId";
57      public static final String ROUTE_NODE_NAME = "routeNodeName";
58      public static final String PROCESS_ID = "processId";
59      public static final String COMPLETE = "complete";
60      public static final String FINAL_APPROVAL = "finalApprovalInd";
61      public static final String KEY = "key";
62      public static final String ROUTE_NODE_STATE_ID = "nodeStateId";
63  
64      // people flow and type
65      public static final String SEQUENCE_NUMBER = "sequenceNumber";
66      
67      public static final Set<String> DOC_SEARCH_RESULT_PROPERTY_NAME_SET = new HashSet<String>();
68      static {
69          DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_DOCUMENT_ID);
70          DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_DOC_TYPE_LABEL);
71          DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_DOCUMENT_TITLE);
72          DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_ROUTE_STATUS_DESC);
73          DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_DOC_STATUS);
74          DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_INITIATOR);
75          DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_DATE_CREATED);
76          DOC_SEARCH_RESULT_PROPERTY_NAME_SET.add(DOC_SEARCH_RESULT_PROPERTY_NAME_ROUTE_LOG);
77      }
78  
79  	// Name of the section in the xml file.
80  	public static final String PERSON_RESP_SECTION = "personResponsibilities";
81  	// Name of the section in the xml file.
82  	public static final String GROUP_RESP_SECTION = "groupResponsibilities";
83  	// Name of the section in the xml file.
84  	public static final String ROLE_RESP_SECTION = "roleResponsibilities";
85  	
86  	public static final Set<String> RESP_SECTION_NAME_SET = new HashSet<String>();
87  	static {
88  		RESP_SECTION_NAME_SET.add(PERSON_RESP_SECTION);
89  		RESP_SECTION_NAME_SET.add(GROUP_RESP_SECTION);
90  		RESP_SECTION_NAME_SET.add(ROLE_RESP_SECTION);
91  	}
92  	
93  	private KEWPropertyConstants() {
94  		throw new UnsupportedOperationException("do not call");
95  	}
96  }