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 org.kuali.rice.kew.engine.RouteContext;
19
20 /**
21 * A rule is an entity that can be evaluated at runtime to generate a list of {@link RuleResponsibilityBo}s
22 * to which to dispatch action requests.
23 * @see RuleBaseValues
24 * @see RuleExpressionResult
25 * @author Kuali Rice Team (rice.collab@kuali.org)
26 */
27 public interface RuleExpression {
28 /**
29 * Performs an evaluation and returns a list of 0 or more {@link RuleResponsibilityBo}s to which to dispatch action requests
30 * @param rule the rule that this rule expression applies to
31 * @param context the RouteContext under which the expression is being evaluated
32 * @return the result of the rule evaluation
33 * @throws org.kuali.rice.kew.api.exception.WorkflowException
34 */
35 public RuleExpressionResult evaluate(Rule rule, RouteContext context);
36 }