View Javadoc

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