1 /**
2 * Copyright 2005-2012 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.krms.framework.engine;
17
18 import org.kuali.rice.krms.api.engine.ExecutionEnvironment;
19
20 /**
21 * An Action executes on a given {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment}
22 *
23 * @see org.kuali.rice.krms.api.repository.action.ActionDefinitionContract
24 * @see org.kuali.rice.krms.api.repository.action.ActionDefinition
25 *
26 * @author Kuali Rice Team (rice.collab@kuali.org)
27 */
28 public interface Action {
29
30 /**
31 * Execute on a given {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment}.
32 * @param environment {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment} to execute.
33 */
34 public void execute(ExecutionEnvironment environment);
35
36 /**
37 * The engine may be run in a simulation mode and in this case,
38 * most actions should not be executed. However, if part or all of
39 * an action needs to be run in order for proper rule evaluation to
40 * proceed, it should be called herein.
41 * @param environment {@link org.kuali.rice.krms.api.engine.ExecutionEnvironment} to simulate execution on.
42 */
43 public void executeSimulation(ExecutionEnvironment environment);
44 }