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.routemodule;
18:
19: import java.util.List;
20:
21: import edu.iu.uis.eden.engine.RouteContext;
22: import edu.iu.uis.eden.exception.WorkflowException;
23: import edu.iu.uis.eden.util.ResponsibleParty;
24:
25: /**
26: * A RouteModule is responsible for generating Action Requests for a given Route Header document.
27: * Implementations of this class are potentially remotable, so this interface uses value objects.
28: *
29: * @author ewestfal
30: * @author rkirkend
31: */
32: public interface RouteModule {
33:
34: /**
35: * Generate action requests for the given RouteContext.
36: *
37: * @return A List of the generated ActionRequestValue objects.
38: * @throws EdenException
39: */
40: public List findActionRequests(RouteContext context)
41: throws Exception;
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 Eden workgroup.
46: * @param rId ResponsibiliyId that we need resolved.
47: * @return The ResponsibleParty containing a key to a user or workgroup.
48: * @throws EdenException if any problems are found this exception can be thrown.
49: */
50: public ResponsibleParty resolveResponsibilityId(
51: Long responsibilityId) throws WorkflowException;
52:
53: }
|