View Javadoc

1   /**
2    * Copyright 2005-2012 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.service;
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  import org.kuali.rice.kew.actionrequest.ActionRequestValue;
25  import org.kuali.rice.kew.actionrequest.Recipient;
26  
27  
28  
29  
30  /**
31   * Main service for doing action list data access work
32   *
33   * @author Kuali Rice Team (rice.collab@kuali.org)
34   *
35   */
36  public interface ActionListService {
37      public ActionItem createActionItemForActionRequest(ActionRequestValue actionRequest);
38  
39      public Collection<ActionItem> getActionList(String principalId, ActionListFilter filter);
40  
41      public Collection<ActionItem> getActionListForSingleDocument(String documentId);
42  
43      public Collection<Recipient> findUserSecondaryDelegators(String principalId);
44  
45      public Collection<Recipient> findUserPrimaryDelegations(String principalId);
46  
47      public boolean refreshActionList(String principalId);
48  
49      public void saveActionItem(ActionItem actionItem);
50  
51      public void deleteActionItem(ActionItem actionItem);
52      
53      public void deleteActionItem(ActionItem actionItem, boolean forceIntoOutbox);
54  
55      public void deleteByDocumentId(String documentId);
56  
57      public Collection<ActionItem> findByPrincipalId(String principalId);
58  
59      public Collection<ActionItem> findByWorkflowUserDocumentId(String workflowUserId, String documentId);
60  
61      public Collection<ActionItem> findByDocumentId(String documentId);
62  
63      public Collection<ActionItem> findByDocumentTypeName(String documentTypeName);
64  
65      public void updateActionItemsForTitleChange(String documentId, String newTitle);
66  
67      public void validateActionItem(ActionItem actionItem);
68  
69      public ActionItem findByActionItemId(String actionItemId);
70  
71      /**
72       * Retrieves the number of Action List items in the given user's primary Action List (does not include secondary delegations)
73       */
74      public int getCount(String principalId);
75  
76      public void saveRefreshUserOption(String principalId);
77  
78      public Collection<ActionItem> findByActionRequestId(String actionRequestId);
79      
80      /**
81       *
82       * Retrieves {@link OutboxItemActionListExtension} items for the given user
83       *
84       * @param principalId
85       * @param filter
86       * @return
87       */
88      public Collection<ActionItem> getOutbox(String principalId, ActionListFilter filter);
89      public Collection<ActionItem> getOutboxItemsByDocumentType(String documentTypeName);
90      public void removeOutboxItems(String principalId, List<String> outboxItems);
91      public void saveOutboxItem(ActionItem actionItem);
92      public void saveOutboxItem(ActionItem actionItem, boolean forceIntoOutbox);
93  }