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.kew.rule;
17
18 import java.sql.Timestamp;
19 import java.util.List;
20
21 import org.kuali.rice.kew.engine.RouteContext;
22 import org.kuali.rice.kew.engine.node.RouteNodeInstance;
23 import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
24
25
26 /**
27 * RuleSelector is responsible for selecting the rules to be evaluated for a given rule-based requests node.
28 * @author Kuali Rice Team (rice.collab@kuali.org)
29 */
30 public interface RuleSelector {
31 /**
32 * Returns a list of rules selected given the criteria specified in the arguments.
33 *
34 * @param context the RouteContext
35 * @param routeHeader the DocumentRouteHeaderValue of the current document
36 * @param nodeInstance the current RouteNodeInstance being executed
37 * @param selectionCriterion an implementation-specific criterion passed in from the calling context
38 * @param effectiveDate an optional criterion that indicates that the rules selected should be active on the given date
39 * @return a list of applicable rules, if any (null or empty list otherwise)
40 * @throws org.kuali.rice.kew.api.exception.WorkflowException if anything goes awry...
41 */
42 /* inputs taken from FlexRM getActionRequests/makeActionRequests */
43 public List<Rule> selectRules(RouteContext context, DocumentRouteHeaderValue routeHeader, RouteNodeInstance nodeInstance, String selectionCriterion, Timestamp effectiveDate);
44 }