com.deliveredtechnologies.rulebook.model

Interface RuleBook<T>

Type Parameters:

T - the Result type

All Known Implementing Classes:

AbstractRuleBookRunner, CoRRuleBook, RuleBookAuditor, RuleBookRunner, RuleBookRunner4PojoClasses, SpringAwareRuleBookRunner, SpringRuleBook

public interface RuleBook<T>

The RuleBook interface for defining objects that handle the behavior of rules chained together.

Method Summary

Modifier and Type	Method and Description
void	addRule(Rule rule) Add a Rule.
default void	defineRules() The defineRules method can be optionally implemented to define rules in a either a completely custom RuleBook or in a RuleBook that extends (subclasses) an existing RuleBook implementation.
java.util.Optional<Result<T>>	getResult() Get the Result of the RuleBook.
boolean	hasRules() The hasRules() method returns true if any Rules have been defined in the RuleBook.
void	run(NameValueReferableMap facts) Run the RuleBook given the facts supplied.
void	setDefaultResult(T result) Set the default Result value; this should be set for RuleBooks that are expected to produce a Result.

Method Detail

addRule

void addRule(Rule rule)

Add a Rule.

Parameters:

rule - the Rule to add to the RuleBook

run

void run(NameValueReferableMap facts)

Run the RuleBook given the facts supplied.

Parameters:

facts - the facts to be applied to the execution of the RuleBook

setDefaultResult

void setDefaultResult(T result)

Set the default Result value; this should be set for RuleBooks that are expected to produce a Result.

Parameters:

result - the default Result value

getResult

java.util.Optional<Result<T>> getResult()

Get the Result of the RuleBook.

Returns:

the Result of the RuleBook

defineRules

default void defineRules()

The defineRules method can be optionally implemented to define rules in a either a completely custom RuleBook or in a RuleBook that extends (subclasses) an existing RuleBook implementation.

hasRules

boolean hasRules()

The hasRules() method returns true if any Rules have been defined in the RuleBook.

Returns:

true if any Rules have been defined in the RuleBook, otherwise false.