|
Oracle Fusion Middleware User Messaging Service 11.1.1.1.0 Java API Reference E14011-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserRule
This Interface represents each of the user defined rules
Method Summary | |
---|---|
void |
addDeviceid(java.lang.String id)
Add a new device ID to the rule |
void |
addFilterCondition(FilterCondition fc)
Add a filter condition to the rule |
boolean |
containsDeviceID(java.lang.String id)
|
boolean |
containsFilterCondition(FilterCondition fc)
|
boolean |
deleteDeviceid(java.lang.String id)
Remove the device id from the device list. |
boolean |
deleteFilterCondition(FilterCondition fc)
Delete the filter condition from the rule |
FilterCondition |
factoryFilterCondition()
Factory method for the filter conditions |
ActionOperationType |
getActionOperation()
Get the action operation type of the rule |
Iterator<java.lang.String> |
getDeviceid()
Get an iterator for the devices selected for the rule |
Iterator<FilterCondition> |
getFilterCondition()
Get an iterator with the filter conditions of the rule |
FilterOperationType |
getFilterOperation()
|
java.lang.String |
getRuleDescription()
|
java.lang.String |
getRuleName()
|
boolean |
isEqual(UserRule u)
Check if two objects represent the same rule |
void |
modifyFilterCondition(FilterCondition fc)
Modify an existing filter condition |
void |
moveDeviceID(int origin,
int destination)
Move a device id to a different position |
void |
moveFilterCondition(int origin,
int destination)
Move a filter condition to a different position |
void |
setActionOperation(ActionOperationType value)
Set the action operation type of the rule |
void |
setFilterOperation(FilterOperationType value)
Set the filter operation of the rule to either ALL_CONDITIONS or ANY_CONDITION |
void |
setRuleDescription(java.lang.String value)
Set the description of the rule |
void |
setRuleName(java.lang.String value)
Set the name of the rule |
int |
sizeDeviceID()
Query the number of devices in the rule |
int |
sizeFilterCondition()
Query the number of filter conditions |
boolean |
validate()
|
Method Detail |
---|
void addDeviceid(java.lang.String id) throws UserRuleSetValidationException
id
- the guid of the device being added
UserRuleSetValidationException
- if the ActionOperationType is
not BROADCAST or FAIL_OVER or if the device has already been added
NOTE: The function does not check if the guid is a valid device.
void addFilterCondition(FilterCondition fc) throws UserRuleSetValidationException
fc
- the filter condition to be added
UserRuleSetValidationException
- if FilterOperation is not set
or FilterCondition is invalidboolean containsDeviceID(java.lang.String id)
id
- the device id to be tested for containment
boolean containsFilterCondition(FilterCondition fc)
fc
- the filter condition to be tested for containment
boolean deleteDeviceid(java.lang.String id)
id
- the guid of the device to be removed
boolean deleteFilterCondition(FilterCondition fc)
fc
- the filter condition to be removed
FilterCondition factoryFilterCondition()
ActionOperationType getActionOperation()
Iterator<java.lang.String> getDeviceid()
Iterator<FilterCondition> getFilterCondition()
FilterOperationType getFilterOperation()
java.lang.String getRuleDescription()
java.lang.String getRuleName()
boolean isEqual(UserRule u)
u
- the UserRule to compare
void modifyFilterCondition(FilterCondition fc) throws UserRuleSetValidationException
fc
- the filter condition to be modified
UserRuleSetValidationException
- if the filter condition is invalid
or does not exist in rulevoid moveDeviceID(int origin, int destination) throws UserRuleSetValidationException
origin
- the current position of the device iddestination
- the position to which the device id will be moved
UserRuleSetValidationException
- if origin is greater than the
number of devicesvoid moveFilterCondition(int origin, int destination) throws UserRuleSetValidationException
origin
- the current position of the filter conditiondestination
- the position to which the filter condition will be moved
UserRuleSetValidationException
- if origin is greater than the
number of filter conditionsvoid setActionOperation(ActionOperationType value)
value
- the action operation type to be setvoid setFilterOperation(FilterOperationType value)
value
- of the FiterOperationType (valid values are ALL_CONDITIONS and ANY_CONDITION)void setRuleDescription(java.lang.String value)
value
- the description of the rulevoid setRuleName(java.lang.String value)
value
- the name of the ruleint sizeDeviceID()
int sizeFilterCondition()
boolean validate() throws UserRuleSetValidationException
UserRuleSetValidationException
- if the object is invalid
|
Oracle Fusion Middleware User Messaging Service 11.1.1.1.0 Java API Reference E14011-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |