oracle.sdp.messaging.userprefs
Interface DeleteAddress

public interface DeleteAddress

Interface that implements the update of the user defined pules after deleting a DeviceAddress

Since:

11.0.0

Method Summary

boolean	execute() Commit the changes to the persistence layer after deleting the specified device.
UserRuleSet	initProcessor(java.lang.String userID, DeviceAddress da) Delete the specified address.

Method Detail

execute

boolean execute()
                throws UserPrefsException,
                       java.lang.IllegalStateException,
                       java.rmi.RemoteException

Commit the changes to the persistence layer after deleting the specified device. DeleteAddress#initProcessor(String,DeviceAddress) should be called first.

Returns:

true if the changes were successful; false otherwise

Throws:

UserPrefsException - thrown if there is a fault or exception on the server side

java.lang.IllegalStateException - thrown if the method is called improperly (e.g. before initialization)

java.rmi.RemoteException - if there is an error on the server side during method call

initProcessor

UserRuleSet initProcessor(java.lang.String userID,
                          DeviceAddress da)
                          throws java.lang.IllegalArgumentException,
                                 ObjectNotFoundException,
                                 UserPrefsException,
                                 UserRuleSetValidationException,
                                 java.rmi.RemoteException

Delete the specified address. This method returns a preview of the User Defined Rules after performing the device deletion. The calling application is responsible to show the changes to the user to avoid data corruption.

Parameters:

userID - the guid of the user

da - the device address to erase

Returns:

a preview of the rulesets before deleting the devices

Throws:

java.lang.IllegalArgumentException - if a parameter is null

ObjectNotFoundException - thrown if userID does not exist

UserPrefsException - thrown if there is a fault or exception on the server side

UserRuleSetValidationException - thrown if the data in the user rule is invalid

java.rmi.RemoteException - if there is an error on the server side during method call