org.milyn.rules
Interface RuleEvalResult

All Known Implementing Classes:

BasicRuleEvalResult, MVELRuleEvalResult, RegexRuleEvalResult

public interface RuleEvalResult

RuleEvalResult is the returned result from a RuleProvider.evaluate(String, CharSequence, org.milyn.container.ExecutionContext) invocation.

Concrete RuleProviders may implement their own custom result that are more specific to the technology used.

Author:

Daniel Bevenius

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.

Method Detail

matched

boolean matched()

The outcome of the rule evaluation.

Returns:

true if successful or false if it failed.

getRuleName

String getRuleName()

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

Returns:

String The name of the rule that created this result.

getRuleProviderName

String getRuleProviderName()

The name of the provider that produced this rule result.

Returns:

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

getEvalException

Throwable getEvalException()

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

Returns:

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