com.cordys.bre.engine

Interface XObject

All Known Implementing Classes:

XObjectImpl

public interface XObject

The object passed to the rule engine for applying the rules, must implement this interface to return and reset the xml representation of the object, for a given rule execution cycle. Rule engine uses this to map the nom-xml references to the java objects

Method Summary

Modifier and Type	Method and Description
void	cleanUp() After rule evaluation this method will be called by the ruleengine.
java.lang.String	getIdentifier() This method will be used by ruleengine to create the hashmap for all xobjects added to the rulesession.
int	getMetadata() The objects passed to the rule engine must implement this method to return xml-nom representation of the meta data of the object.
void	setXml(int xml) After evaluation of rules ,rule engine will call the set xml on all xObjects inside rulesession objects .
int	toOriginalXml() The objects passed to the rule engine must implement this method to return xml-nom representation of the original data of the object.
int	toXml() The objects passed to the rule engine must implement this method to return the xml-nom representation of the current data of the object.

Method Detail

toXml

int toXml()

The objects passed to the rule engine must implement this method to return the xml-nom representation of the current data of the object.

Returns:

the xml-nom representation of the object

setXml

void setXml(int xml)

After evaluation of rules ,rule engine will call the set xml on all xObjects inside rulesession objects .

toOriginalXml

int toOriginalXml()

The objects passed to the rule engine must implement this method to return xml-nom representation of the original data of the object. Mostly applicable in case of the objects being updated.

Returns:

the xml-nom representation of the object

getMetadata

int getMetadata()

The objects passed to the rule engine must implement this method to return xml-nom representation of the meta data of the object. *

Returns:

the xml-nom representation of the object metadata.

cleanUp

void cleanUp()

After rule evaluation this method will be called by the ruleengine. Implementation should contain any clean up(nom node deletes) that has to be done.

getIdentifier

java.lang.String getIdentifier()

This method will be used by ruleengine to create the hashmap for all xobjects added to the rulesession. The objects inside rule session can be read back using the rulesession.getXObject(String xObjectIdenfier)