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.krms.framework.engine;
017    
018    import org.kuali.rice.krms.api.engine.ExecutionEnvironment;
019    
020    /**
021     * A Rule evaluates a given {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment}, returning true if its conditions pass, false if they do not.
022     *
023     * @see org.kuali.rice.krms.api.repository.rule.RuleDefinitionContract
024     * @see org.kuali.rice.krms.api.repository.rule.RuleDefinition
025     *
026     * @author Kuali Rice Team (rice.collab@kuali.org)
027     */
028    public interface Rule {
029    
030        /**
031         * Evaluate a given {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment}, returning true if the rules conditions pass, false if they do not.
032         * @param environment ExecutionEnvironment
033         * @return true if given {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment} the rule's conditions pass, false if they do not
034         */
035            public boolean evaluate(ExecutionEnvironment environment);
036    }