View Javadoc
1   /**
2    * Copyright 2005-2014 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.routeheader.dao;
17  
18  import org.kuali.rice.kew.docsearch.SearchableAttributeValue;
19  import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
20  import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValueContent;
21  
22  import java.util.Collection;
23  import java.util.Set;
24  
25  /**
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   */
28  public interface DocumentRouteHeaderDAO {
29  
30      /**
31       * "Locks" the route header at the datasource level.
32       */
33      void lockRouteHeader(String documentId);
34  
35      DocumentRouteHeaderValue findRouteHeader(String documentId, boolean clearCache);
36  
37      Collection<DocumentRouteHeaderValue> findRouteHeaders(Collection<String> documentIds);
38  
39      Collection<DocumentRouteHeaderValue> findRouteHeaders(Collection<String> documentIds, boolean clearCache);
40  
41      String getNextDocumentId();
42  
43      Collection<String> findPendingByResponsibilityIds(Set<String> responsibilityIds);
44  
45      void clearRouteHeaderSearchValues(String documentId);
46  
47      Collection<SearchableAttributeValue> findSearchableAttributeValues(String documentId);
48  
49      String getApplicationIdByDocumentId(String documentId);
50  
51      DocumentRouteHeaderValueContent getContent(String documentId);
52  
53      boolean hasSearchableAttributeValue(String documentId, String searchableAttributeKey,
54              String searchableAttributeValue);
55  
56      String getDocumentStatus(String documentId);
57  
58      void save(SearchableAttributeValue searchableAttribute);
59  
60      String getAppDocId(String documentId);
61  
62      String getAppDocStatus(String documentId);
63  
64      Collection findByDocTypeAndAppId(String documentTypeName, String appId);
65  
66  }