org.kuali.rice.krms.api.engine

Enum ExecutionFlag

java.lang.Object

java.lang.Enum<ExecutionFlag>

org.kuali.rice.krms.api.engine.ExecutionFlag

All Implemented Interfaces:

Serializable, Comparable<ExecutionFlag>

public enum ExecutionFlag
extends Enum<ExecutionFlag>

Defines various possible flags that can be used to control how the rules engine executes and performs it's evaluation of rules. These flags are meant to be set to either true or false. This is done using the ExecutionOptions that are passed to the engine at execution time.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

ExecutionOptions

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTEXT_MUST_EXIST Indicates that the selection criteria which is passed to the engine at the time of execution must be able to select a valid context in order for engine execution to proceed.
EVALUATE_ALL_PROPOSITIONS Instructs the engine to evaluate all propositions.
LOG_EXECUTION Indicates that the engine should perform default logging by recording each ResultEvent in the EngineResults.

Method Summary

Modifier and Type	Method and Description
boolean	getDefaultValue() Returns the default value for the flag if it has not been explicitly set.
static ExecutionFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExecutionFlag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOG_EXECUTION

public static final ExecutionFlag LOG_EXECUTION

Indicates that the engine should perform default logging by recording each ResultEvent in the EngineResults. Default value is false.

See Also:

EngineResults

CONTEXT_MUST_EXIST

public static final ExecutionFlag CONTEXT_MUST_EXIST

Indicates that the selection criteria which is passed to the engine at the time of execution must be able to select a valid context in order for engine execution to proceed. Default value is false, when false the engine will simply not execute if no valid context can be located for the specified selection criteria.

See Also:

SelectionCriteria

EVALUATE_ALL_PROPOSITIONS

public static final ExecutionFlag EVALUATE_ALL_PROPOSITIONS

Instructs the engine to evaluate all propositions. If this value is set to false, the engine may skip (aka short circuit) propositions that do not influence the overall outcome of the proposition tree.

Method Detail

values

public static ExecutionFlag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExecutionFlag c : ExecutionFlag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExecutionFlag valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDefaultValue

public boolean getDefaultValue()

Returns the default value for the flag if it has not been explicitly set.

Returns:

the default value for the flag