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.ken.service;
17
18 import org.kuali.rice.ken.bo.NotificationMessageDelivery;
19 import org.kuali.rice.kew.api.WorkflowDocument;
20
21
22 /**
23 * The NotificationWorkflowDocumentService class is responsible for housing service methods for interacting with KEW.
24 * @author Kuali Rice Team (rice.collab@kuali.org)
25 */
26 public interface NotificationWorkflowDocumentService {
27 /**
28 * This service method is responsible for creating a NotificationWorkflowDocument for the given user, which in turn,
29 * creates a workflow document in KEW. It then ad-hoc routes the document to the passed in recipient. This
30 * method will be used by the NotificationService.deliverNotification() service method.
31 * @param messageDelivery - the specific NotificationMessageDelivery that is associated with this ad hoc route
32 * @param initiatorUserId - the person/workflow user who is responsible for "initiating" this workflow document
33 * @param recipientUserId - the person/workflow user who will recieve this document via an ad hoc route
34 * @param annotation - a description of the workflow ad hoc route transaction
35 * @return String - the id of the workflow document
36 */
37 public String createAndAdHocRouteNotificationWorkflowDocument(NotificationMessageDelivery messageDelivery, String initiatorUserId,
38 String recipientUserId, String annotation);
39
40 /**
41 * This method is responsible for canceling a workflow document; which in turn simulates the "checking-off"
42 * of a notification in the notification list by the system through an auto-removal.
43 * @param initiatorUserId
44 * @param workflowDocument
45 * @param annotation
46 */
47 public void clearAllFyisAndAcknowledgeNotificationWorkflowDocument(String initiatorUserId, WorkflowDocument workflowDocument, String annotation);
48
49 /**
50 * This method is responsible for unconditionally terminating a workflow document, after which there should be no
51 * pending action requests against this document.
52 * @param document workflow document to terminate
53 */
54 public void terminateWorkflowDocument(WorkflowDocument document);
55
56 /**
57 * This service method is responsible for retrieving a NotificationWorkflowDocument from KEW.
58 * @param initiatorUserId
59 * @param workflowDocumentId
60 * @return NotificationWorkflowDocument
61 */
62 public WorkflowDocument getNotificationWorkflowDocumentByDocumentId(String initiatorUserId, String workflowDocumentId);
63 }