01: /*
02: * Copyright 2005-2006 The Kuali Foundation.
03: *
04: *
05: * Licensed under the Educational Community License, Version 1.0 (the "License");
06: * you may not use this file except in compliance with the License.
07: * You may obtain a copy of the License at
08: *
09: * http://www.opensource.org/licenses/ecl1.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 edu.iu.uis.eden.clientapp;
18:
19: import java.rmi.RemoteException;
20:
21: import edu.iu.uis.eden.clientapp.vo.ActionRequestVO;
22: import edu.iu.uis.eden.clientapp.vo.ResponsiblePartyVO;
23: import edu.iu.uis.eden.clientapp.vo.RouteHeaderVO;
24:
25: /**
26: * A RouteModule is responsible for generating Action Requests for a given Route Header document.
27: * Implementations of this Interface are potentially remotable, so this Interface uses value objects.
28: *
29: * @author ewestfal
30: */
31: public interface RouteModuleRemote {
32:
33: /**
34: * Generate action requests for the given RouteHeaderVO.
35: *
36: * @return ActionRequestVO[] the generated action requests
37: * @throws EdenException
38: */
39: public ActionRequestVO[] findActionRequests(
40: RouteHeaderVO routeHeader) throws RemoteException;
41:
42: /**
43: * The route module will resolve the given responsibilityId and return an object that contains the key to
44: * either a user or a Eden workgroup.
45: * @param rId ResponsibiliyId that we need resolved.
46: * @return The ResponsibleParty containing a key to a user or workgroup.
47: * @throws EdenException if any problems are found this exception can be thrown.
48: */
49: public ResponsiblePartyVO resolveResponsibilityId(
50: Long responsibilityId) throws RemoteException;
51:
52: }
|