oracle.sdp.messaging.userprefs
Interface RuleSet

All Superinterfaces:

Serializable, UserPrefsObject

public interface RuleSet
extends UserPrefsObject

This interface represents the RuleSet that is associated with each user.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.sdp.messaging.userprefs.UserPrefsObject

UserPrefsObject.PrefsObjectType

Method Summary

java.lang.String	getFilterXml()
java.lang.String	getRL()
byte[]	getRuleSession() Get the RuleSession (in serialized form).
java.lang.String	getUserId()
void	setFilterXml(java.lang.String filterXml) Set the filter (RuleSet) in XML form.
void	setRL(java.lang.String rl) Set the RuleSet in RL (Rule Language) form.
void	setRuleSession(byte[] ruleSession) Set the RuleSession (in serialized form) This method is called only if the "optimizeRuleSession" flag is set.
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc) This method is used by the provisioning classes

Methods inherited from interface oracle.sdp.messaging.userprefs.UserPrefsObject

getCreatedDate, getDescription, getLastModifiedDate, getPrefsObjectType, getVersion, isValid, setDescription, setValid

Method Detail

getFilterXml

java.lang.String getFilterXml()

Returns:

the filter (RuleSet) in XML form

getRL

java.lang.String getRL()

Returns:

the ruleset as it is processed by the rule engine. It is in the RL language that is parsed by the rule engine

getRuleSession

byte[] getRuleSession()

Get the RuleSession (in serialized form). This method is called only if the "optimizeRuleSession" flag is set. By default, RuleSession is not serialized.

Returns:

serialized RL

getUserId

java.lang.String getUserId()

Returns:

the userId that uniquely identifies this ruleset

setFilterXml

void setFilterXml(java.lang.String filterXml)

Set the filter (RuleSet) in XML form.

Parameters:

filterXml - the the ruleset (filter) to be applied

setRL

void setRL(java.lang.String rl)

Set the RuleSet in RL (Rule Language) form.

Parameters:

rl - the ruleset to be parsed by the rule engine

setRuleSession

void setRuleSession(byte[] ruleSession)

Set the RuleSession (in serialized form) This method is called only if the "optimizeRuleSession" flag is set. By default, RuleSession is not serialized.

Parameters:

ruleSession - the serialized RL

toXML

org.w3c.dom.Element toXML(org.w3c.dom.Document doc)

This method is used by the provisioning classes

Parameters:

doc - the root of the provisioning document

Returns:

the element for ruleset in the provisioning document