de.janrufmonitor.framework.rules
Interface IRuleEngine

public interface IRuleEngine

This interface must be implemented by a rule engine object. A rule engine takes care about all rules in the framework. It should be singleton implementation.

Author:

Thilo Brandt

Method Summary

void	addRule(IRule rule) Adds a new rule to the rule engine.
IRule	createRule(String rule) Creates new rule object.
IRule	createRule(String serviceID, IMsn msn, ICip cip, boolean active, IPhonenumber[] phones) Creates new rule object.
IRule	createRule(String serviceID, IMsn msn, ICip cip, boolean active, IPhonenumber[] phones, IPhonenumber[] exphones) Creates new rule object.
IRule	createRule(String serviceID, IMsn msn, ICip cip, boolean active, IPhonenumber[] phones, IPhonenumber[] exphones, String timeslot) Creates new rule object.
IRule	createRule(String serviceID, String msn, String cip, boolean active, IPhonenumber[] phones) Creates new rule object.
IRule	createRule(String serviceID, String msn, String cip, IPhonenumber phone) Creates new rule object.
List	getRules() Gets a list with all rules handled by the rule engine.
void	removeRule(IRule rule) Removes a rule from the rule engine.
void	shutdown() This method is called on shutdown time by the runtime object.
void	startup() This method is called on startup time by the runtime object.
boolean	validate(IRule rule) Checks if a certain rule is validated
boolean	validate(String serviceID, IMsn msn, ICip cip, IPhonenumber phone) Checks a service ID, MSN obejct and a CIP object are based in a rule stored in the rule engine.
boolean	validate(String serviceID, String msn, String cip, IPhonenumber phone) Checks a service ID, MSN obejct and a CIP object are based in a rule stored in the rule engine.

Method Detail

validate

boolean validate(IRule rule)

Checks if a certain rule is validated

Parameters:

rule - rule to be validated

Returns:

true if the rule is validated, false if not

validate

boolean validate(String serviceID,
                 IMsn msn,
                 ICip cip,
                 IPhonenumber phone)

Checks a service ID, MSN obejct and a CIP object are based in a rule stored in the rule engine.

Parameters:

serviceID - service ID of the service to be checked

msn - MSN object

cip - CIP object

phone - Phonenumber object

Returns:

true if the rule is validated, false if not

validate

boolean validate(String serviceID,
                 String msn,
                 String cip,
                 IPhonenumber phone)

Checks a service ID, MSN obejct and a CIP object are based in a rule stored in the rule engine.

Parameters:

serviceID - service ID of the service to be checked

msn - MSN string

cip - CIP string

phone - phonenumber object

Returns:

true if the rule is validated, false if not

createRule

IRule createRule(String rule)

Creates new rule object.

Parameters:

rule - string representation of a rule

Returns:

e new rule object

createRule

IRule createRule(String serviceID,
                 IMsn msn,
                 ICip cip,
                 boolean active,
                 IPhonenumber[] phones)

Creates new rule object.

Parameters:

serviceID - service ID of the service to be checked

msn - MSN object

cip - CIP object

active - current status of the rule

phones - phonenumber objects

Returns:

e new rule object

createRule

IRule createRule(String serviceID,
                 IMsn msn,
                 ICip cip,
                 boolean active,
                 IPhonenumber[] phones,
                 IPhonenumber[] exphones)

Creates new rule object.

Parameters:

serviceID - service ID of the service to be checked

msn - MSN object

cip - CIP object

active - current status of the rule

phones - phonenumber objects

exphones - phonenumber objects for exclusion

Returns:

e new rule object

createRule

IRule createRule(String serviceID,
                 IMsn msn,
                 ICip cip,
                 boolean active,
                 IPhonenumber[] phones,
                 IPhonenumber[] exphones,
                 String timeslot)

Creates new rule object.

Parameters:

serviceID - service ID of the service to be checked

msn - MSN object

cip - CIP object

active - current status of the rule

phones - phonenumber objects

exphones - phonenumber objects for exclusion

timeslot - encoded timeslot data

Returns:

e new rule object

createRule

IRule createRule(String serviceID,
                 String msn,
                 String cip,
                 boolean active,
                 IPhonenumber[] phones)

Creates new rule object.

Parameters:

serviceID - service ID of the service to be checked

msn - MSN string

cip - CIP string

active - current status of the rule

phones - phonenumber objects

Returns:

e new rule object

createRule

IRule createRule(String serviceID,
                 String msn,
                 String cip,
                 IPhonenumber phone)

Creates new rule object.

Parameters:

serviceID - service ID of the service to be checked

msn - MSN string

cip - CIP string

phone - phonenumber object

Returns:

e new rule object

getRules

List getRules()

Gets a list with all rules handled by the rule engine.

Returns:

a list with all rules

addRule

void addRule(IRule rule)

Adds a new rule to the rule engine.

Parameters:

rule - rule to be added.

removeRule

void removeRule(IRule rule)

Removes a rule from the rule engine.

Parameters:

rule - rule to be removed.

startup

void startup()

This method is called on startup time by the runtime object.

shutdown

void shutdown()

This method is called on shutdown time by the runtime object.