View Javadoc

1   /**
2    * Copyright 2005-2011 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.actionlist.dao;
17  
18  import java.util.Collection;
19  import java.util.List;
20  
21  import org.kuali.rice.kew.actionitem.ActionItem;
22  import org.kuali.rice.kew.actionitem.OutboxItemActionListExtension;
23  import org.kuali.rice.kew.actionlist.ActionListFilter;
24  
25  
26  /**
27   * Data Access object for the Action List.
28   *
29   * @see ActionItem
30   *
31   * @author Kuali Rice Team (rice.collab@kuali.org)
32   */
33  public interface ActionListDAO {
34      public Collection<ActionItem> getActionList(String principalId, ActionListFilter filter);
35      public Collection<ActionItem> getActionListForSingleDocument(String documentId);
36      public int getCount(String workflowId);
37  
38      /**
39       *
40       * Retrieves {@link OutboxItemActionListExtension} items for the given user
41       *
42       * @param principalId
43       * @param filter
44       * @return
45       */
46      public Collection<ActionItem> getOutbox(String principalId, ActionListFilter filter);
47      public void removeOutboxItems(String principalId, List<String> outboxItems);
48      public void saveOutboxItem(OutboxItemActionListExtension outboxItem);
49      public OutboxItemActionListExtension getOutboxByDocumentId(String documentId);
50      public OutboxItemActionListExtension getOutboxByDocumentIdUserId(String documentId, String userId);
51  }