Coverage Report

Coverage Report - org.kuali.rice.kew.rule.RuleSelector

Classes in this File

 /*
  * Copyright 2007 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.opensource.org/licenses/ecl2.php
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.kuali.rice.kew.rule;
 
 import java.sql.Timestamp;
 import java.util.List;
 
 import org.kuali.rice.kew.engine.RouteContext;
 import org.kuali.rice.kew.engine.node.RouteNodeInstance;
 import org.kuali.rice.kew.exception.WorkflowException;
 import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
 
 
 /**
  * RuleSelector is responsible for selecting the rules to be evaluated for a given rule-based requests node.
  * @author Kuali Rice Team (rice.collab@kuali.org)
  */
 public interface RuleSelector {
     /**
      * Returns a list of rules selected given the criteria specified in the arguments.
      * 
      * @param context the RouteContext
      * @param routeHeader the DocumentRouteHeaderValue of the current document
      * @param nodeInstance the current RouteNodeInstance being executed
      * @param selectionCriterion an implementation-specific criterion passed in from the calling context
      * @param effectiveDate an optional criterion that indicates that the rules selected should be active on the given date 
      * @return a list of applicable rules, if any (null or empty list otherwise)
      * @throws WorkflowException if anything goes awry...
      */
     /* inputs taken from FlexRM getActionRequests/makeActionRequests */
     public List<Rule> selectRules(RouteContext context, DocumentRouteHeaderValue routeHeader, RouteNodeInstance nodeInstance, String selectionCriterion, Timestamp effectiveDate) throws WorkflowException;
 }

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