oracle.sdp.messaging.userprefs
Interface UserRuleSet

All Superinterfaces:

Serializable, UserPrefsObject

public interface UserRuleSet
extends UserPrefsObject

This Interface represent all the User Defined Rules for a given guid

Since:

11.0.0

Nested Class Summary

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

UserPrefsObject.PrefsObjectType

Method Summary

void	addUserRule(UserRule ur) Add a new UserRule to the User Defined Rules
boolean	containsUserRule(UserRule ur)
boolean	deleteUserRule(UserRule ur) Deletes the UserRule from the RuleSet.
boolean	deleteUserRuleWithName(java.lang.String ruleName) Deletes the specified rule from the RuleSet.
UserRule	factoryUserRule() Factory method for UserRule classes
java.lang.String	getGuid()
Iterator<RuleTermType>	getSupportedTermTypes()
Iterator<UserRule>	getUserRule()
java.lang.String	getXMLString()
boolean	isEqual(UserRuleSet urs) Check if the two objects represents the same rule
void	modifyUserRule(UserRule ur) Modifies and Updatse an already added UserRule
void	moveUserRule(int origin, int dest) Moves a UserRule to a diferent position
RuleTermType	ruleTermTypeFactory(java.lang.String name)
int	sizeUserRule()
boolean	validate() Check that the Object is valid

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

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

Method Detail

addUserRule

void addUserRule(UserRule ur)
                 throws UserRuleSetValidationException

Add a new UserRule to the User Defined Rules

Parameters:

ur - the UserRule to add

Throws:

UserRuleSetValidationException - if the parameter is not a valid UserRule or if another UserRule with the same name has been added

containsUserRule

boolean containsUserRule(UserRule ur)

Parameters:

ur - element whose presence in this list is to be tested

Returns:

Returns true if the UserRule is part of the class

deleteUserRule

boolean deleteUserRule(UserRule ur)

Deletes the UserRule from the RuleSet.

Parameters:

ur - the UserRule to remove

Returns:

true if the UserRule contained the specified element.

deleteUserRuleWithName

boolean deleteUserRuleWithName(java.lang.String ruleName)

Deletes the specified rule from the RuleSet.

Parameters:

ruleName - name of the UserRule to remove

Returns:

true if the UserRule contained the specified element.

factoryUserRule

UserRule factoryUserRule()

Factory method for UserRule classes

Returns:

the Class created

getGuid

java.lang.String getGuid()

Returns:

the User Unique ID of the UserRuleSet

getSupportedTermTypes

Iterator<RuleTermType> getSupportedTermTypes()

getUserRule

Iterator<UserRule> getUserRule()

Returns:

An Iterator of the UserRule defined

getXMLString

java.lang.String getXMLString()
                              throws UserRuleSetValidationException

Returns:

the XML document that represents the defined rules

Throws:

UserRuleSetValidationException - if the UserRuleSet is not a valid one

isEqual

boolean isEqual(UserRuleSet urs)

Check if the two objects represents the same rule

Parameters:

urs - the UserRuleSet to compare

Returns:

true if both Objects represent the same condition, false otherwise

modifyUserRule

void modifyUserRule(UserRule ur)
                    throws UserRuleSetValidationException

Modifies and Updatse an already added UserRule

Parameters:

ur - UserRule to update, it must be already into the UserRuleSet

Throws:

UserRuleSetValidationException - if the UserRule is invalid, the user rule is not in the UserRuleSet or the rule introduce a duplicated RuleName

moveUserRule

void moveUserRule(int origin,
                  int dest)
                  throws UserRuleSetValidationException

Moves a UserRule to a diferent position

Parameters:

origin - UserRule current position

dest - Place where the UserRule will be placed

Throws:

UserRuleSetValidationException - if origin is greater than the number of UserRules

ruleTermTypeFactory

RuleTermType ruleTermTypeFactory(java.lang.String name)

sizeUserRule

int sizeUserRule()

Returns:

The number of UserRule on the class

validate

boolean validate()
                 throws UserRuleSetValidationException

Check that the Object is valid

Returns:

true of the object is valid

Throws:

UserRuleSetValidationException - if the object is not valid