|
Oracle Fusion Middleware User Messaging Service 11.1.1.3.0 Java API Reference E14011-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserPrefsServices
This is the root interface for creating, deleting, and finding the user extension objects such as devices, addresses, rulesets, etc.
Method Summary | |
---|---|
DeviceAddress |
createDeviceAddress(UserDevice userDevice,
java.lang.String address)
Create a device address for use in User Delivery Preference. |
RuleSet |
createRuleSet(java.lang.String userID)
|
UserDevice |
createUserDevice(java.lang.String userID,
java.lang.String name)
Create a new user device object. |
UserRuleSet |
createUserRuleSet(java.lang.String userID)
Create user rule set for the specified user. |
void |
delete(UserPrefsObject object)
Delete the specified UserPrefsObject. |
Set<DeviceAddress> |
findAllDeviceAddresses(DeliveryType[] deliveryTypes,
java.lang.String addressExp)
|
DeviceAddress |
findDeviceAddress(java.lang.String address)
Finds the device address object which contains the specified address value. |
Set<RuleSet> |
findRuleSets(java.lang.String[] guids)
Find the rule sets for the specified users. |
Set<UserDevice> |
findUserDevices(java.lang.String userID,
java.lang.String nameExp)
Finds all user devices for a given user id that match the user name name regular expression value. |
Set<UserRuleSet> |
findUserRuleSets(java.lang.String[] guids)
|
BusinessRuleTerm[] |
getBusinessRuleTerms()
|
java.lang.String |
getBusinessTermType(java.lang.String businessTermName)
|
DeviceAddress |
getDefaultAddress(java.lang.String userID)
gets the DefaultAddress of the specified user |
DeliveryPreference |
getDeliveryPreference(java.lang.String userID,
Hashtable<java.lang.String,java.lang.Object> facts)
getDeliveryPreference |
Set<DeliveryPreference> |
getDeliveryPreferences(java.lang.String[] guids,
Hashtable<java.lang.String,java.lang.Object> facts)
getDeliveryPreferences |
Set<DeviceAddress> |
getDeviceAddresses(java.lang.String[] addrids)
Get device addresses for the specified address ids. |
Set<DeviceAddress> |
getDeviceAddresses(java.lang.String userGUID,
java.lang.String[] addrids)
Get device addresses for the specified user and address ids. |
RuleSet |
getRuleSet(java.lang.String userID)
Get the rule set for the specified user. |
UserRuleSet |
getUserRuleSet(java.lang.String userID)
Retrieve the rule set for the specified userID. |
UserRuleSet |
getUserRuleSet(java.lang.String userID,
boolean create)
Retrieve the rule set for the specified userID, and specify whether to create a new rule set if one does not already exist. |
TermOperationType[] |
getValidOperations(java.lang.String type)
|
void |
reload(UserPrefsObject object)
|
void |
removeRuleSet(java.lang.String userID)
Remove the rule set for the specified user. |
void |
removeUserRuleSet(java.lang.String userID)
|
void |
save(UserPrefsObject object)
|
Method Detail |
---|
DeviceAddress createDeviceAddress(UserDevice userDevice, java.lang.String address) throws UserPrefsException, java.lang.IllegalArgumentException, ObjectAlreadyExistsException
userDevice
- the device to which the created address is associatedaddress
- the unique user device address
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if a parameter is null
ObjectAlreadyExistsException
- if duplicate object creation is attemptedRuleSet createRuleSet(java.lang.String userID) throws UserPrefsException, java.lang.IllegalArgumentException, ObjectAlreadyExistsException
userID
- globally unique user id
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if the userID is null
ObjectAlreadyExistsException
- if duplicate object creation is attemptedUserDevice createUserDevice(java.lang.String userID, java.lang.String name) throws UserPrefsException, java.lang.IllegalArgumentException, ObjectAlreadyExistsException
userID
- globally unique user idname
- the name of the user device. It is unique per device.
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if userID or name is null
ObjectAlreadyExistsException
- if duplicate object creation is attemptedUserRuleSet createUserRuleSet(java.lang.String userID) throws UserPrefsException, java.lang.IllegalArgumentException, ObjectAlreadyExistsException
userID
- globally unique user id
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if the userID is null
ObjectAlreadyExistsException
- if duplicate object creation is attemptedvoid delete(UserPrefsObject object) throws UserPrefsException, java.lang.IllegalArgumentException, ObjectNotFoundException
object
- Object(RuleSet, DeviceAddress, UserDevice) to be removed from the persistent store.
UserPrefsException
- thrown if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if the argument is null
ObjectNotFoundException
- if the UserPrefsObject does not existSet<DeviceAddress> findAllDeviceAddresses(DeliveryType[] deliveryTypes, java.lang.String addressExp) throws UserPrefsException, java.lang.IllegalArgumentException
deliveryTypes
- array of delivery type objectsaddressExp
- the regular expression of the address. The expression is limited to semantics
of 'LIKE' clause in SQL.
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if a parameter is nullDeviceAddress findDeviceAddress(java.lang.String address) throws UserPrefsException, java.lang.IllegalArgumentException
address
- the address value for the device address
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if a parameter is nullSet<RuleSet> findRuleSets(java.lang.String[] guids) throws UserPrefsException
guids
- the array of global user ids
UserPrefsException
- if there is a fault or exception on the server sideSet<UserDevice> findUserDevices(java.lang.String userID, java.lang.String nameExp) throws UserPrefsException
userID
- globally unique user idnameExp
- the regular expression of the user device name. The expression is limited to semantics
of 'LIKE' clause in SQL.
UserPrefsException
- if there is a fault or exception on the server sideSet<UserRuleSet> findUserRuleSets(java.lang.String[] guids) throws UserPrefsException
guids
- array of global user ids
UserPrefsException
- if there is a fault or exception on the server sideBusinessRuleTerm[] getBusinessRuleTerms()
java.lang.String getBusinessTermType(java.lang.String businessTermName)
businessTermName
- the name of the Business Term
DeviceAddress getDefaultAddress(java.lang.String userID) throws UserPrefsException
userID
-
UserPrefsException
DeliveryPreference getDeliveryPreference(java.lang.String userID, Hashtable<java.lang.String,java.lang.Object> facts) throws UserPrefsException, java.lang.IllegalArgumentException
userID
- the user idfacts
- the hashtable containing the business terms and values
UserPrefsException
java.lang.IllegalArgumentException
Set<DeliveryPreference> getDeliveryPreferences(java.lang.String[] guids, Hashtable<java.lang.String,java.lang.Object> facts) throws UserPrefsException
guids
- array of user idsfacts
- the hashtable containing the business terms and values
UserPrefsException
Set<DeviceAddress> getDeviceAddresses(java.lang.String[] addrids) throws UserPrefsException
addrids
- the array of global device address ids
UserPrefsException
- if there is a fault or exception on the server sideSet<DeviceAddress> getDeviceAddresses(java.lang.String userGUID, java.lang.String[] addrids) throws UserPrefsException
userGUID
- globally unique idaddrids
- the array of global device address ids
UserPrefsException
- if there is a fault or exception on the server sideRuleSet getRuleSet(java.lang.String userID) throws UserPrefsException, java.lang.IllegalArgumentException
userID
- the unique id for the RuleSet
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if userID is nullUserRuleSet getUserRuleSet(java.lang.String userID) throws UserPrefsException, java.lang.IllegalArgumentException, ObjectNotFoundException
userID
- the unique id for the RuleSet
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if userID is null
ObjectNotFoundException
- if no rule set exists for the specified userUserRuleSet getUserRuleSet(java.lang.String userID, boolean create) throws UserPrefsException, java.lang.IllegalArgumentException, ObjectNotFoundException
userID
- the unique id for the RuleSetcreate
- flag to indicate if a user rule set should be created if it does not exist
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if userID is null
ObjectNotFoundException
- if no rule set exists for the specified user, and
the create parameter is falseTermOperationType[] getValidOperations(java.lang.String type)
type
- String describing the Business Term Type
void reload(UserPrefsObject object) throws UserPrefsException, java.lang.IllegalArgumentException
object
- Object (RuleSet, DeviceAddress, UserDevice) to be reloaded from the persistent
store. It will then hold the current vaues.
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if the argument is nullvoid removeRuleSet(java.lang.String userID) throws UserPrefsException, java.lang.IllegalArgumentException, ObjectNotFoundException
userID
- the unique id for the RuleSet
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if userID is null
ObjectNotFoundException
- thrown if rule set does not existvoid removeUserRuleSet(java.lang.String userID) throws UserPrefsException, java.lang.IllegalArgumentException, ObjectNotFoundException
userID
- the unique id for the UserRuleSet
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if userID is null
ObjectNotFoundException
- if userID does not existvoid save(UserPrefsObject object) throws UserPrefsException, java.lang.IllegalArgumentException
object
- Object(RuleSet, DeviceAddress, UserDevice) to be saved into the persistent store. This
is used to permanantly save the values of the object after any changes have been made.
UserPrefsException
- if there is a fault or exception on the server side
java.lang.IllegalArgumentException
- if the argument is null
|
Oracle Fusion Middleware User Messaging Service 11.1.1.3.0 Java API Reference E14011-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |