org.jeasy.rules.api

Interface Rule

All Superinterfaces:

Comparable<Rule>

All Known Implementing Classes:

BasicRule, CompositeRule

public interface Rule
extends Comparable<Rule>

Abstraction for a rule that can be fired by the rules engine. Rules are registered in the rules engine registry and must have a unique name.

Author:

Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DESCRIPTION Default rule description.
static String	DEFAULT_NAME Default rule name.
static int	DEFAULT_PRIORITY Default rule priority.

Method Summary

Modifier and Type	Method and Description
boolean	evaluate(Facts facts) Rule conditions abstraction : this method encapsulates the rule's conditions.
void	execute(Facts facts) Rule actions abstraction : this method encapsulates the rule's actions.
String	getDescription() Getter for rule description.
String	getName() Getter for rule name.
int	getPriority() Getter for rule priority.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

DEFAULT_NAME

static final String DEFAULT_NAME

Default rule name.

See Also:

Constant Field Values

DEFAULT_DESCRIPTION

static final String DEFAULT_DESCRIPTION

Default rule description.

See Also:

Constant Field Values

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

Default rule priority.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Getter for rule name.

Returns:

the rule name

getDescription

String getDescription()

Getter for rule description.

Returns:

rule description

getPriority

int getPriority()

Getter for rule priority.

Returns:

rule priority

evaluate

boolean evaluate(Facts facts)

Rule conditions abstraction : this method encapsulates the rule's conditions.

Returns:

true if the rule should be applied given the provided facts, false else

execute

void execute(Facts facts)
      throws Exception

Rule actions abstraction : this method encapsulates the rule's actions.

Throws:

Exception - thrown if an exception occurs during actions performing