Skip navigation links

com.sigmadynamics.sdo.rules
Interface RuleEvaluator

public interface RuleEvaluator

Since:

3.0

Method Summary

void	abortQueuedTasks() Use this method to clear the rule compilation queue.
boolean	evaluate(java.lang.Object context, RuleDefinition def, RuleCache cache, EvaluationOptions opts) Deprecated.
boolean	evaluateEligibilityRule(java.lang.Object context, RuleDefinition def, RuleCache cache, EvaluationOptions opts) Evaluate an external eligibility rule.
double	evaluateScoringRule(RuleDefinition def, RuleCache cache, EvaluationOptions opts) Evaluate an external scoring rule.
java.util.List<RuleDefinitionContextPair>	validateAndCache(java.util.List<RuleDefinitionContextPair> ruleDefContextList, RuleCache cache) Use this method to preload external rules in bulk at ILS deploy time.
boolean	validateAndCache(java.lang.Object context, RuleDefinition def, RuleCache cache) Use this method to preload external rules at ILS deploy time.

Method Detail

evaluate

boolean evaluate(java.lang.Object context,
                 RuleDefinition def,
                 RuleCache cache,
                 EvaluationOptions opts)
                 throws ValidationException,
                        EvaluationException

Deprecated.

Parameters:

context -

def -

cache -

opts -

Returns:

Throws:

ValidationException

EvaluationException

evaluateEligibilityRule

boolean evaluateEligibilityRule(java.lang.Object context,
                                RuleDefinition def,
                                RuleCache cache,
                                EvaluationOptions opts)
                                throws ValidationException,
                                       EvaluationException

Evaluate an external eligibility rule.

Parameters:

context - A Choice object for choice eligbility rules, a choice group for choice group eligibility rules, null for filtering rules.

def - RuleDefinition to be evaluated.

cache - The RuleCache from the Application.

opts - Evaluation options.

Returns:

the boolean value of the rule, or default return value specified by opts.

Throws:

ValidationException - if the rule fails to compile and if opts.RuntimeExceptionPolicy() == RuntimeExceptionPolicy.THROW.

EvaluationException - if the execution of the rule fails and if opts.RuntimeExceptionPolicy() == RuntimeExceptionPolicy.THROW.

evaluateScoringRule

double evaluateScoringRule(RuleDefinition def,
                           RuleCache cache,
                           EvaluationOptions opts)
                           throws ValidationException,
                                  EvaluationException

Evaluate an external scoring rule.

Parameters:

def - RuleDefinition to be evaluated.

cache - The RuleCache from the Application.

opts - Evaluation options.

Returns:

the double value of the rule, or default return value specified by opts.

Throws:

ValidationException - if the rule fails to compile and if opts.RuntimeExceptionPolicy() == RuntimeExceptionPolicy.THROW.

EvaluationException - if the execution of the rule fails and if opts.RuntimeExceptionPolicy() == RuntimeExceptionPolicy.THROW.

validateAndCache

boolean validateAndCache(java.lang.Object context,
                         RuleDefinition def,
                         RuleCache cache)
                         throws ValidationException

Use this method to preload external rules at ILS deploy time.

Parameters:

context - A Choice object for choice eligbility rules, a choice group for choice group eligibility rules, null for filtering rules.

def - RuleDefinition to be evaluated.

cache - The RuleCache from the Application.

Returns:

true if the rule compiled and was cached successfully, false if the rule didn't compile and was cached as an invalid rule.

Throws:

ValidationException - if the rule fails to compile and if opts.RuntimeExceptionPolicy() == RuntimeExceptionPolicy.THROW.

validateAndCache

java.util.List<RuleDefinitionContextPair> validateAndCache(java.util.List<RuleDefinitionContextPair> ruleDefContextList,
                                                           RuleCache cache)

Use this method to preload external rules in bulk at ILS deploy time.

Parameters:

ruleDefContextList - a list of pairs of rule definitions and context objects. Context objects may be a Choice object for choice eligibility rules, a choice group for choice group eligibility rules, null for filtering rules.

cache - The RuleCache from the Application.

abortQueuedTasks

void abortQueuedTasks()

Use this method to clear the rule compilation queue. (For development & testing)

Skip navigation links