001/**
002 * Copyright 2005-2016 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 */
016package org.kuali.rice.krms.api.engine;
017
018import java.util.Map;
019
020/**
021 * An Engine executes using the given {@link SelectionCriteria}, @{link Facts}, and {@link ExecutionOptions} returning {@link EngineResults}
022 * 
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025public interface Engine {
026
027        /**
028         * Initiates execution of the rules engine.
029         * 
030         * @param selectionCriteria informs the engine of the {@link SelectionCriteria} to use for selection of contexts and agendas
031         * @param facts the facts that the rule engine can use during execution
032         * @param executionOptions defines various {@link ExecutionOptions} that instruct the rules engine on how to perform it's execution
033         * 
034         * @return {@link EngineResults} the results of engine execution
035         */
036        EngineResults execute(SelectionCriteria selectionCriteria, Facts facts, ExecutionOptions executionOptions);
037
038    /**
039     * Initiates execution of the rules engine.
040     *
041     * @param selectionCriteria informs the engine of the {@link SelectionCriteria} to use for selection of contexts and agendas
042     * @param facts the facts that the rule engine can use during execution.  Since this signature does not pass in
043     * {@link Term}s, all terms are defined with only a name, and term parameters can not be specified.
044     * @param executionOptions defines various {@link ExecutionOptions} that instruct the rules engine on how to perform it's execution
045     *
046     * @return the results of engine execution
047     */
048    EngineResults execute(SelectionCriteria selectionCriteria, Map<String, Object> facts, ExecutionOptions executionOptions);
049
050}