public interface UserCommunicationPreference extends Serializable
Modifier and Type | Method and Description |
---|---|
DeviceAddress |
createDeviceAddress(String guid,
String deviceName,
DeliveryType deliveryType,
String address)
Creates a user device address managed by User Communication
Preferences (UCP).
|
void |
delete(UserPrefsObject object)
Deletes the specified user preference object from persistent
store..
|
Map<String,BusinessRuleTerm> |
getBusinessterms()
Gets all the supported business terms.
|
DeviceAddress[] |
getDefaultAddresses(String guid,
String profileId)
Gets a user's default addresses for specified profile.
|
String |
getDefaultProfileId()
Gets the ID for the default application partition profile.
|
DeliveryPreference |
getDeliveryPreference(String guid,
String profileId,
Map<String,Object> facts)
Gets a user's delivery preferences.
|
Set<DeviceAddress> |
getDeviceAddresses(String guid)
Gets a user's all device addresses.
|
Set<DeviceAddress> |
getDeviceAddresses(String guid,
DeviceAddressType type)
Gets user device addresses of a particular type.
|
Set<DeviceAddress> |
getDeviceAddresses(String guid,
String profileId)
Gets a user's device addresses for a specific profile.
|
FilterSet |
getFilterSet(String guid,
String profileId)
Gets, or creates if not exist, a user's FilterSet for given
profile.
|
Locale |
getLocale(String guid)
Gets a user's preferred locale from identity management (IDM)
service.
|
ReadonlyProfile |
getReadonlyProfile(String profileId)
Gets a read only partition profile.
|
Set<String> |
getSupportedDeliveryTypes()
Gets delivery types that are supported by this User Messaging
Services (UMS) server.
|
TimeZone |
getTimeZone(String guid)
Gets a user's preferred time zone from identity management (IDM)
service.
|
String |
getUserAttribute(String guid,
String key)
Gets a user's attribute value by attribute's name.
|
Map<String,String> |
getUserAttributes(String guid)
Gets a user's all attributes as name-value pairs
|
boolean |
isDefaultAddress(String guid,
String profileId,
DeviceAddress deviceAdress)
Checks if the address is a default address in the specified
profile.
|
void |
removeDefaultAddress(String guid,
String profileId,
DeviceAddress defaultAddress)
Removes an address from the default address set in the specified
profile.
|
void |
removeUserAttribute(String guid,
String key)
Removes a user attribute.
|
void |
save(UserPrefsObject object)
Saves a user preference object to persistent store.
|
void |
setDefaultAddress(String guid,
String profileId,
DeviceAddress defaultAddress)
Sets an address as default in the specified profile.
|
void |
setUserAttribute(String guid,
String key,
String value)
Sets a new attribute value.
|
DeliveryPreference getDeliveryPreference(String guid, String profileId, Map<String,Object> facts) throws UserPrefsException, IllegalArgumentException
guid
- global ID of the user, case sensitive.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.facts
- a map of name/value pairs for the business terms and
corresponding facts. Filters are evaluated based on the
facts supplied in this call. A client must supply all
the relevant facts in order for this API to select the
best matched filter.UserPrefsException
- if there is any error in the operation.IllegalArgumentException
- if user id or profile is invalid.Locale getLocale(String guid)
guid
- global ID of the user, case sensitive.TimeZone getTimeZone(String guid)
guid
- global ID of the user, case sensitive.String getUserAttribute(String guid, String key)
guid
- global ID of the user, case sensitive.key
- name of the attribute. Attribute name is case sensitive.void setUserAttribute(String guid, String key, String value) throws UserPrefsException
guid
- global ID of the user, case sensitive.key
- name of the attribute. Attribute name is case sensitive.value
- new value to be set to that attribute. The value is a
string that can be up to 256 bytes long. If null is
given, that attribute will be deleted.UserPrefsException
- if there is any error in the operation.void removeUserAttribute(String guid, String key)
guid
- global ID of the user, case sensitive.key
- name of the attributeMap<String,String> getUserAttributes(String guid)
guid
- global ID of the user, case sensitive.FilterSet getFilterSet(String guid, String profileId) throws UserPrefsException, IllegalArgumentException, ObjectAlreadyExistsException
guid
- global ID of the user, case sensitive.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.UserPrefsException
- if there is any error in the operation.IllegalArgumentException
- if user id or profile is invalid.ObjectAlreadyExistsException
- if the filter set already exists.Set<DeviceAddress> getDeviceAddresses(String guid)
guid
- global ID of the user, case sensitive.Set<DeviceAddress> getDeviceAddresses(String guid, String profileId)
guid
- global ID of the user, case sensitive.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.Set<DeviceAddress> getDeviceAddresses(String guid, DeviceAddressType type)
guid
- global ID of the user, case sensitive.type
- of device addresses to be retrieved.DeviceAddress createDeviceAddress(String guid, String deviceName, DeliveryType deliveryType, String address) throws UserPrefsException
guid
- global ID of the user, case sensitive.deviceName
- unique name of the user device.deliveryType
- type of the device.address
- of the device.UserPrefsException
- if there is any error in the operation.DeviceAddress[] getDefaultAddresses(String guid, String profileId) throws UserPrefsException
guid
- global ID of the user, case sensitive.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.UserPrefsException
- if there is any error in the operation.void setDefaultAddress(String guid, String profileId, DeviceAddress defaultAddress) throws UserPrefsException
guid
- global ID of the user, case sensitive.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.defaultAddress
- the address to be added.UserPrefsException
- if there is any error in the operation.void removeDefaultAddress(String guid, String profileId, DeviceAddress defaultAddress) throws UserPrefsException
guid
- global ID of the user, case sensitive.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.defaultAddress
- the address to be removed from the default set.UserPrefsException
- if there is any error in the operation.boolean isDefaultAddress(String guid, String profileId, DeviceAddress deviceAdress)
guid
- global ID of the user, case sensitive.profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.deviceAdress
- the address to be checked.String getDefaultProfileId()
ReadonlyProfile getReadonlyProfile(String profileId)
profileId
- application partitioning profile ID. The default profile
is applied if a null is specified.Map<String,BusinessRuleTerm> getBusinessterms()
Set<String> getSupportedDeliveryTypes()
void save(UserPrefsObject object) throws UserPrefsException, IllegalArgumentException
object
- (FilterSet, DeviceAddress) 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 any error in the operation.IllegalArgumentException
- if the argument is null.void delete(UserPrefsObject object) throws UserPrefsException, IllegalArgumentException, ObjectNotFoundException
object
- (FilterSet, DeviceAddress) to be removed from the
persistent store.UserPrefsException
- if there is any error in the operation.IllegalArgumentException
- if the argument is null.ObjectNotFoundException
- if the UserPrefsObject does not exist.Copyright © 2009,2013 Oracle and/or its affiliates. All rights reserved.