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.framework.engine;
017
018import org.kuali.rice.krms.api.engine.ExecutionEnvironment;
019
020/**
021 * An Action executes on a given {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment}
022 *
023 * @see org.kuali.rice.krms.api.repository.action.ActionDefinitionContract
024 * @see org.kuali.rice.krms.api.repository.action.ActionDefinition
025 *
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028public interface Action {
029
030    /**
031     * Execute on a given {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment}.
032     * @param environment {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment} to execute.
033     */
034        public void execute(ExecutionEnvironment environment);
035
036        /**
037         * The engine may be run in a simulation mode and in this case,
038         * most actions should not be executed.  However, if part or all of 
039         * an action needs to be run in order for proper rule evaluation to 
040         * proceed, it should be called herein.
041     * @param environment {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment} to simulate execution on.
042         */
043        public void executeSimulation(ExecutionEnvironment environment);
044}