org.ikasan.component.endpoint.rulecheck

Interface Rule<EVENT,TRIGGER>

All Known Implementing Classes:

DailyEventRuleRule, RelativeTimeIntervalRule

public interface Rule<EVENT,TRIGGER>

Rule contract.

Author:

Ikasan Development Team.

Method Summary

Methods

Modifier and Type	Method and Description
void	check(TRIGGER trigger) Has the rule been breached.
void	rebase() Allow the rule to be rebased to reset any rule state
void	update(EVENT event) Event hitting the rule at runtime

Method Detail

rebase

void rebase()

Allow the rule to be rebased to reset any rule state

update

void update(EVENT event)

Event hitting the rule at runtime

Parameters:

event -

check

void check(TRIGGER trigger)
           throws RuleBreachException

Has the rule been breached. If the rule isn't breached then do nothing. If the rule is breached then a RuleBreachException (or sub-class of) exception is thrown.

Parameters:

trigger -

Throws:

RuleBreachException