org.milyn.rules
Class BasicRuleEvalResult

java.lang.Object
  org.milyn.rules.BasicRuleEvalResult

All Implemented Interfaces:

Serializable, RuleEvalResult

Direct Known Subclasses:

MVELRuleEvalResult, RegexRuleEvalResult

public class BasicRuleEvalResult
extends Object
implements RuleEvalResult, Serializable

Basic rule evaluation result.

Author:

tom.fennelly@jboss.com

See Also:

Serialized Form

Constructor Summary

BasicRuleEvalResult(boolean matched, String ruleName, String ruleProviderName)

BasicRuleEvalResult(Throwable evalException, String ruleName, String ruleProviderName)

Method Summary

Throwable	getEvalException() Get any provider level exceptions that may have occured during the rule evaluation.
String	getRuleName() Gets the name of the Rule that this class is a result of.
String	getRuleProviderName() The name of the provider that produced this rule result.
boolean	matched() The outcome of the rule evaluation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicRuleEvalResult

public BasicRuleEvalResult(boolean matched,
                           String ruleName,
                           String ruleProviderName)

BasicRuleEvalResult

public BasicRuleEvalResult(Throwable evalException,
                           String ruleName,
                           String ruleProviderName)

Method Detail

matched

public boolean matched()

Description copied from interface: RuleEvalResult

The outcome of the rule evaluation.

Specified by:

matched in interface RuleEvalResult

Returns:

true if successful or false if it failed.

getRuleName

public String getRuleName()

Description copied from interface: RuleEvalResult

Gets the name of the Rule that this class is a result of.

Specified by:

getRuleName in interface RuleEvalResult

Returns:

String The name of the rule that created this result.

getRuleProviderName

public String getRuleProviderName()

Description copied from interface: RuleEvalResult

The name of the provider that produced this rule result.

Specified by:

getRuleProviderName in interface RuleEvalResult

Returns:

String The name of the Rule provider that produced this result.

getEvalException

public Throwable getEvalException()

Description copied from interface: RuleEvalResult

Get any provider level exceptions that may have occured during the rule evaluation.

Specified by:

getEvalException in interface RuleEvalResult

Returns:

A provider level exception that occured during rule evaluation, or null if no evaluation exception occured.