1 /*
2 * Copyright 2005-2007 The Kuali Foundation
3 *
4 *
5 * Licensed under the Educational Community License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.opensource.org/licenses/ecl2.php
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.kuali.rice.kew.routemodule;
18
19 import org.kuali.rice.kew.api.action.ActionRequest;
20 import org.kuali.rice.kew.dto.DocumentContentDTO;
21 import org.kuali.rice.kew.dto.ResponsiblePartyDTO;
22 import org.kuali.rice.kew.dto.RouteHeaderDTO;
23
24 import java.rmi.RemoteException;
25 import java.util.List;
26
27
28 /**
29 * A RouteModule is responsible for generating Action Requests for a given Route Header document.
30 * Implementations of this Interface are potentially remotable, so this Interface uses value objects.
31 *
32 * @author Kuali Rice Team (rice.collab@kuali.org)
33 */
34 public interface RouteModuleRemote {
35
36 /**
37 * Generate action requests for the given RouteHeaderVO.
38 *
39 * @return ActionRequestVO[] the generated action requests
40 */
41 public List<ActionRequest> findActionRequests(RouteHeaderDTO routeHeader, DocumentContentDTO documentContent) throws RemoteException;
42
43 /**
44 * The route module will resolve the given responsibilityId and return an object that contains the key to
45 * either a user or a workgroup.
46 * @param rId ResponsibiliyId that we need resolved.
47 * @return The ResponsibleParty containing a key to a user or workgroup.
48 */
49 public ResponsiblePartyDTO resolveResponsibilityId(String responsibilityId) throws RemoteException;
50
51 }