net.bobosse.gwt.rulesengine.client

Interface Rule

All Superinterfaces:

HasFollowing<Rule>, HasPreceeding<Rule>

All Known Implementing Classes:

AbstractRule, NullOrEmptyRule, RegexRule

public interface Rule
extends HasPreceeding<Rule>, HasFollowing<Rule>

A Rule process a fact (Object), and according to filters, may fire some actions.

Author:

sesa202001

Method Summary

Methods

Modifier and Type	Method and Description
boolean	activate() Set rule state to active
boolean	addCommand(RuledCommand command) Add an RuledCommand to fire when rule matches
void	clearCommands() Remove all actions triggered by this Rule when it matches.
void	execute(Object fact, Report report) Execute business logic, using specific Rule implementation.
void	executeCommands() call each RuledCommand's execute() method
List<RuledCommand>	getCommands()
Object	getFact()
String	getName()
Report	getReport()
int	getSalience() Rule salience is an int between -100 an 100.
boolean	isActive()
boolean	passivate() Set rule state to passive (will not be processed)
boolean	removeCommand(RuledCommand command) Remove an RuledCommand to fire when rule matches

Methods inherited from interface net.bobosse.gwt.rulesengine.client.HasPreceeding

getPreceeding

Methods inherited from interface net.bobosse.gwt.rulesengine.client.HasFollowing

getFollowing

Method Detail

addCommand

boolean addCommand(RuledCommand command)

Add an RuledCommand to fire when rule matches

Parameters:

command -

Returns:

removeCommand

boolean removeCommand(RuledCommand command)

Remove an RuledCommand to fire when rule matches

Parameters:

command -

Returns:

getCommands

List<RuledCommand> getCommands()

Returns:

list of RuledCommand to fire when rule matches

getSalience

int getSalience()

Rule salience is an int between -100 an 100. Higher is this value, higher is the priority of the rule. High priority rules will be executed first.

Returns:

rule's salience

execute

void execute(Object fact,
           Report report)

Execute business logic, using specific Rule implementation. This is the good place to call executeCommands().

isActive

boolean isActive()

Returns:

true if rule is active, false otherwise

activate

boolean activate()

Set rule state to active

Returns:

previous active status

passivate

boolean passivate()

Set rule state to passive (will not be processed)

Returns:

previous active status

clearCommands

void clearCommands()

Remove all actions triggered by this Rule when it matches.

getName

String getName()

Returns:

rule's name

getFact

Object getFact()

Returns:

what is tested by this rule during current session. If null, throw an IllegalStateException.

getReport

Report getReport()

Returns:

where processing information should be stored. As this is mandatory, throw an IllegalStateException if null.

executeCommands

void executeCommands()

call each RuledCommand's execute() method