1 /**
2 * Copyright 2005-2013 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.krad.service;
17
18 import java.util.List;
19
20 import org.kuali.rice.krad.bo.AdHocRoutePerson;
21 import org.kuali.rice.krad.bo.AdHocRouteRecipient;
22 import org.kuali.rice.krad.bo.AdHocRouteWorkgroup;
23 import org.kuali.rice.krad.document.Document;
24
25 /**
26 * This service populates {@link Document}s with {@link AdHocRoutePerson}s and {@link AdHocRouteWorkgroup}s
27 *
28 * @author Kuali Rice Team (rice.collab@kuali.org)
29 */
30 public interface DocumentAdHocService {
31
32 /**
33 * This method populates the given {@link Document} with the {@link AdHocRoutePerson}s and {@link AdHocRouteWorkgroup}s
34 * that are associated with it.
35 *
36 * @param doc
37 */
38 void addAdHocs(Document doc);
39
40 /**
41 * This method replaces the current ad-hoc recipients for a given document with the provided list.
42 *
43 * @param documentNumber Document Number to which to attach the route log recipients. All existing stored ad-hoc recipients will be deleted.
44 * @param adHocRoutingRecipients New list of ad-hoc recipients (Persons and Workgroups) which will be attached to the document.
45 */
46 void replaceAdHocsForDocument( String documentNumber, List<AdHocRouteRecipient> adHocRoutingRecipients );
47 }