1 /**
2 * Copyright 2005-2011 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.kew.routemodule;
17
18 import java.util.List;
19
20 import org.kuali.rice.kew.actionrequest.ActionRequestValue;
21 import org.kuali.rice.kew.api.exception.WorkflowException;
22 import org.kuali.rice.kew.engine.RouteContext;
23 import org.kuali.rice.kew.util.ResponsibleParty;
24
25
26 /**
27 * A RouteModule is responsible for generating Action Requests for a given Route Header document.
28 * Implementations of this class are potentially remotable, so this interface uses value objects.
29 *
30 * @author Kuali Rice Team (rice.collab@kuali.org)
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 */
39 List<ActionRequestValue> findActionRequests(RouteContext context) throws Exception;
40
41 /**
42 * The route module will resolve the given responsibilityId and return an object that contains the key to
43 * either a user or a workgroup.
44 * @param rId ResponsibiliyId that we need resolved.
45 * @return The ResponsibleParty containing a key to a user or workgroup.
46 */
47 ResponsibleParty resolveResponsibilityId(String responsibilityId) throws WorkflowException;
48
49 /**
50 * Returns true if this RouteModule has more requests available which it can generate. This method will only be
51 * called after the first set of action requests returned by the first invocation of findActionRequests have been
52 * fully activated. If this method returns true, findActionRequests will be invoked again and those requests will
53 * all be activated before the cycle continues until this method returns false;
54 *
55 * @param context the route context
56 * @return true if this route module has more requests it can generate, false otherwise
57 */
58 boolean isMoreRequestsAvailable(RouteContext context);
59
60 }