org.xulux.api.rules
Interface IRuleEngine

public interface IRuleEngine

The main rule engine interface. This is the way to plugin your own custom rule engine, or eg drools. The internal nyx rule engine will be an implementation that is always available in the core system and can be used in combination with any ruleengine. The custom rule engine however will take precedence over the internal one. So in case of drools, first all drools rules will be fired and after that the internal rule system.

Version:

$Id: IRuleEngine.java,v 1.1 2005/12/18 12:58:23 mvdb Exp $

Author:

Martin van den Bemt

Field Summary

static int	DESTROY_REQUEST The request must fire destroy in rule
static int	EXECUTE_REQUEST The request must fire execute in rule
static int	INIT_REQUEST The request must fire init in rule
static int	POST_REQUEST The request must fire post in rule
static int	PRE_REQUEST The request must fire pre in rule

Method Summary

void	fireFieldRequest(IWidget widget, PartRequest request, int type) Fire requests for the specified field.
void	fireFieldRequests(PartRequest request, int type) Fire request on the specfied part
void	fireRequest(PartRequest request, int type) Fire a single request.
void	stopAllRules() Do not continue any rules left in the rule queue.

Field Detail

PRE_REQUEST

static final int PRE_REQUEST

The request must fire pre in rule

See Also:

Constant Field Values

EXECUTE_REQUEST

static final int EXECUTE_REQUEST

The request must fire execute in rule

See Also:

Constant Field Values

POST_REQUEST

static final int POST_REQUEST

The request must fire post in rule

See Also:

Constant Field Values

INIT_REQUEST

static final int INIT_REQUEST

The request must fire init in rule

See Also:

Constant Field Values

DESTROY_REQUEST

static final int DESTROY_REQUEST

The request must fire destroy in rule

See Also:

Constant Field Values

Method Detail

fireFieldRequest

void fireFieldRequest(IWidget widget,
                      PartRequest request,
                      int type)

Fire requests for the specified field.

Parameters:

widget - the widget the request is for

request - the request object

type - the type of request

fireFieldRequests

void fireFieldRequests(PartRequest request,
                       int type)

Fire request on the specfied part

Parameters:

request - the request object

type - the type of request

fireRequest

void fireRequest(PartRequest request,
                 int type)

Fire a single request.

Parameters:

request - the request object

type - the type of request

stopAllRules

void stopAllRules()

Do not continue any rules left in the rule queue. It should act as if all rules are actually processed.