001    /**
002     * Copyright 2005-2011 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     */
016    package org.kuali.rice.kew.actionlist.service;
017    
018    import java.util.Collection;
019    import java.util.List;
020    
021    import org.kuali.rice.kew.actionitem.ActionItem;
022    import org.kuali.rice.kew.actionitem.OutboxItemActionListExtension;
023    import org.kuali.rice.kew.actionlist.ActionListFilter;
024    import org.kuali.rice.kew.actionrequest.ActionRequestValue;
025    import org.kuali.rice.kew.actionrequest.Recipient;
026    
027    
028    
029    
030    /**
031     * Main service for doing action list data access work
032     *
033     * @author Kuali Rice Team (rice.collab@kuali.org)
034     *
035     */
036    public interface ActionListService {
037        public ActionItem createActionItemForActionRequest(ActionRequestValue actionRequest);
038    
039        public Collection<ActionItem> getActionList(String principalId, ActionListFilter filter);
040    
041        public Collection<ActionItem> getActionListForSingleDocument(String documentId);
042    
043        public Collection<Recipient> findUserSecondaryDelegators(String principalId);
044    
045        public Collection<Recipient> findUserPrimaryDelegations(String principalId);
046    
047        public boolean refreshActionList(String principalId);
048    
049        public void saveActionItem(ActionItem actionItem);
050    
051        public void deleteActionItem(ActionItem actionItem);
052        
053        public void deleteActionItem(ActionItem actionItem, boolean forceIntoOutbox);
054    
055        public void deleteByDocumentId(String documentId);
056    
057        public Collection<ActionItem> findByPrincipalId(String principalId);
058    
059        public Collection<ActionItem> findByWorkflowUserDocumentId(String workflowUserId, String documentId);
060    
061        public Collection<ActionItem> findByDocumentId(String documentId);
062    
063        public Collection<ActionItem> findByDocumentTypeName(String documentTypeName);
064    
065        public void updateActionItemsForTitleChange(String documentId, String newTitle);
066    
067        public void validateActionItem(ActionItem actionItem);
068    
069        public ActionItem findByActionItemId(String actionItemId);
070    
071        /**
072         * Retrieves the number of Action List items in the given user's primary Action List (does not include secondary delegations)
073         */
074        public int getCount(String principalId);
075    
076        public void saveRefreshUserOption(String principalId);
077    
078        public Collection<ActionItem> findByActionRequestId(String actionRequestId);
079        
080        /**
081         *
082         * Retrieves {@link OutboxItemActionListExtension} items for the given user
083         *
084         * @param principalId
085         * @param filter
086         * @return
087         */
088        public Collection<ActionItem> getOutbox(String principalId, ActionListFilter filter);
089        public Collection<ActionItem> getOutboxItemsByDocumentType(String documentTypeName);
090        public void removeOutboxItems(String principalId, List<String> outboxItems);
091        public void saveOutboxItem(ActionItem actionItem);
092        public void saveOutboxItem(ActionItem actionItem, boolean forceIntoOutbox);
093    }