001/**
002 * Copyright 2005-2017 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.kew.routeheader.dao;
017
018import org.kuali.rice.kew.docsearch.SearchableAttributeValue;
019import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
020import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValueContent;
021
022import java.util.Collection;
023import java.util.Set;
024
025/**
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028public interface DocumentRouteHeaderDAO {
029
030    /**
031     * "Locks" the route header at the datasource level.
032     */
033    void lockRouteHeader(String documentId);
034
035    DocumentRouteHeaderValue findRouteHeader(String documentId, boolean clearCache);
036
037    Collection<DocumentRouteHeaderValue> findRouteHeaders(Collection<String> documentIds);
038
039    Collection<DocumentRouteHeaderValue> findRouteHeaders(Collection<String> documentIds, boolean clearCache);
040
041    String getNextDocumentId();
042
043    Collection<String> findPendingByResponsibilityIds(Set<String> responsibilityIds);
044
045    void clearRouteHeaderSearchValues(String documentId);
046
047    Collection<SearchableAttributeValue> findSearchableAttributeValues(String documentId);
048
049    String getApplicationIdByDocumentId(String documentId);
050
051    DocumentRouteHeaderValueContent getContent(String documentId);
052
053    boolean hasSearchableAttributeValue(String documentId, String searchableAttributeKey,
054            String searchableAttributeValue);
055
056    String getDocumentStatus(String documentId);
057
058    void save(SearchableAttributeValue searchableAttribute);
059
060    String getAppDocId(String documentId);
061
062    String getAppDocStatus(String documentId);
063
064    Collection findByDocTypeAndAppId(String documentTypeName, String appId);
065
066}