org.xulux.api.rules
Interface IRule

public interface IRule

All rules must implement this interfaces.

Version:

$Id: IRule.java,v 1.1 2005/12/18 12:58:16 mvdb Exp $

Author:

Martin van den Bemt

Method Summary

void	deregisterPartName(java.lang.String partName) Method derigsterPartName.
void	destroy() Destroys the rule when removed from the context
void	execute(PartRequest request) The actual rule will be processed here.
IWidget	getOwner()
int	getUseCount() How many times is the current rule used
void	init() Initializes the rule This initialization is context wide.
boolean	isRegistered(java.lang.String partName) Method isRegistered.
void	post(PartRequest request) Post processing of the rule This is mainly changing states in eg components after the executer has been process.
void	pre(PartRequest request) Preprocessing of the rule.
void	registerPartName(java.lang.String partName) Method registerPartName.

Method Detail

init

void init()

Initializes the rule This initialization is context wide. So any processing done here, will preserve state among all calls to the rule

pre

void pre(PartRequest request)

Preprocessing of the rule. This is mainly changes state of eg the current component that is about to process

Parameters:

request - the request object

execute

void execute(PartRequest request)

The actual rule will be processed here.

Parameters:

request - the request object

post

void post(PartRequest request)

Post processing of the rule This is mainly changing states in eg components after the executer has been process.

Parameters:

request - the request object

destroy

void destroy()

Destroys the rule when removed from the context

getUseCount

int getUseCount()

How many times is the current rule used

Returns:

the usecount for this rule

registerPartName

void registerPartName(java.lang.String partName)

Method registerPartName.

Parameters:

partName - the name of the part

deregisterPartName

void deregisterPartName(java.lang.String partName)

Method derigsterPartName.

Parameters:

partName - the name of the part

isRegistered

boolean isRegistered(java.lang.String partName)

Method isRegistered.

Parameters:

partName - the name of the part

Returns:

boolean if the part was registered

getOwner

IWidget getOwner()

Returns:

the owner of this rule