001/**
002 * Copyright 2005-2016 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.actionlist.dao;
017
018import java.util.Collection;
019import java.util.List;
020
021import org.kuali.rice.kew.actionitem.ActionItem;
022import org.kuali.rice.kew.actionitem.ActionItemActionListExtension;
023import org.kuali.rice.kew.actionitem.OutboxItemActionListExtension;
024import org.kuali.rice.kew.actionlist.ActionListFilter;
025
026
027/**
028 * Data Access object for the Action List.
029 *
030 * @see ActionItem
031 *
032 * @author Kuali Rice Team (rice.collab@kuali.org)
033 */
034public interface ActionListDAO {
035    public Collection<ActionItemActionListExtension> getActionList(String principalId, ActionListFilter filter);
036    public Collection<ActionItemActionListExtension> getActionListForSingleDocument(String documentId);
037    public int getCount(String workflowId);
038    public List<Object> getMaxActionItemDateAssignedAndCountForUser(String principalId);
039
040    /**
041     *
042     * Retrieves {@link OutboxItemActionListExtension} items for the given user
043     *
044     * @param principalId
045     * @param filter
046     * @return
047     */
048    public Collection<OutboxItemActionListExtension> getOutbox(String principalId, ActionListFilter filter);
049    public void removeOutboxItems(String principalId, List<String> outboxItems);
050    public void saveOutboxItem(OutboxItemActionListExtension outboxItem);
051    public OutboxItemActionListExtension getOutboxByDocumentId(String documentId);
052    public OutboxItemActionListExtension getOutboxByDocumentIdUserId(String documentId, String userId);
053}