com.prosyst.mprm.admin.rule

Enum Rule.State

java.lang.Object

java.lang.Enum<Rule.State>

com.prosyst.mprm.admin.rule.Rule.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Rule.State>

Enclosing interface:

Rule

public static enum Rule.State
extends java.lang.Enum<Rule.State>

Defines possible Rule states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFINED The Rule enters this state right after it is created (see RuleEngine.createRule(String), RuleEngine.createRule(String, Scope, Trigger, ExecOptions, String), RuleBuilder.buildRule()), or modified (see Rule.modify(String), Rule.modify(String, Scope, Trigger, ExecOptions, String)).
DISABLED Marks that Rule is deactivated (see Rule.disable()) and no more triggers may happen in this state.
ENABLED Marks that Rule is activated (see Rule.enable()) and might be triggered whenever the respective fires and conditions happen.
FAILED_TO_ENABLE Marks that Rule has failed to be enabled.

Method Summary

Modifier and Type	Method and Description
int	getValue() Returns an integer value corresponding to the predefined status.
static Rule.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Rule.State[]	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

DEFINED

public static final Rule.State DEFINED

The Rule enters this state right after it is created (see RuleEngine.createRule(String), RuleEngine.createRule(String, Scope, Trigger, ExecOptions, String), RuleBuilder.buildRule()), or modified (see Rule.modify(String), Rule.modify(String, Scope, Trigger, ExecOptions, String)).

ENABLED

public static final Rule.State ENABLED

Marks that Rule is activated (see Rule.enable()) and might be triggered whenever the respective fires and conditions happen.

DISABLED

public static final Rule.State DISABLED

Marks that Rule is deactivated (see Rule.disable()) and no more triggers may happen in this state.

FAILED_TO_ENABLE

public static final Rule.State FAILED_TO_ENABLE

Marks that Rule has failed to be enabled. Usually in this case the Rule.getStateDescription() method should bring a detail description of what exactly has failed and prevented the Rule from activation.

Method Detail

values

public static Rule.State[] 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 (Rule.State c : Rule.State.values())
    System.out.println(c);

Returns:

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

valueOf

public static Rule.State valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

Returns an integer value corresponding to the predefined status.

Returns:

integer mapping corresponding to the predefined status.