001    /**
002     * Copyright 2005-2013 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.kew.rule;
017    
018    import org.kuali.rice.kew.engine.RouteContext;
019    
020    /**
021     * A rule is an entity that can be evaluated at runtime to generate a list of {@link RuleResponsibilityBo}s
022     * to which to dispatch action requests.
023     * @see RuleBaseValues
024     * @see RuleExpressionResult
025     * @author Kuali Rice Team (rice.collab@kuali.org)
026     */
027    public interface RuleExpression {
028        /**
029         * Performs an evaluation and returns a list of 0 or more {@link RuleResponsibilityBo}s to which to dispatch action requests
030         * @param rule the rule that this rule expression applies to
031         * @param context the RouteContext under which the expression is being evaluated
032         * @return the result of the rule evaluation
033         * @throws org.kuali.rice.kew.api.exception.WorkflowException
034         */
035        public RuleExpressionResult evaluate(Rule rule, RouteContext context);
036    }