oracle.sdp.messaging.userprefs
Interface UserDevice

All Superinterfaces:

Serializable, UserPrefsObject

public interface UserDevice
extends UserPrefsObject

This class represents the logical user device. It can contain several physical devices. It is uniquely identified by its 'name'. The uniqueness is only mandated in the context of a User and not across different User objects

Nested Class Summary

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

UserPrefsObject.PrefsObjectType

Method Summary

boolean	addAddress(DeviceAddress address)
void	addAllAddresses(Set<DeviceAddress> addresses)
Set<DeviceAddress>	getAddresses()
Set<DeviceAddress>	getAddresses(DeliveryType type)
java.lang.String	getDeviceId() Returns the unique id by which it is identified in the persistence store.
java.lang.String	getName()
java.lang.String	getUserID()
boolean	removeAddress(DeviceAddress address)
void	removeAllAddresses() Empties the list of addresses
void	setName(java.lang.String name)
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc)

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

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

Method Detail

addAddress

boolean addAddress(DeviceAddress address)

Parameters:

address - the address to be added to the device list

addAllAddresses

void addAllAddresses(Set<DeviceAddress> addresses)

Parameters:

addresses - the addresses to be added to the existing set

getAddresses

Set<DeviceAddress> getAddresses()
                                throws UserPrefsException

Returns:

a read-only list of all addresses. Note that modifications to the DeviceAddress objects that are part of the list are not synchronized

Throws:

UserPrefsException

getAddresses

Set<DeviceAddress> getAddresses(DeliveryType type)
                                throws UserPrefsException

Parameters:

type - - delivery type

Returns:

the set of device addresses that can deliver messages over the channel represented by the delivery type. If the argument is null, it is equivalent to getAddresses() method above.

Throws:

UserPrefsException

getDeviceId

java.lang.String getDeviceId()

Returns the unique id by which it is identified in the persistence store. Note that the device id is a read-only property.

Returns:

unique device id

getName

java.lang.String getName()

Returns:

name of the user device

getUserID

java.lang.String getUserID()

Returns:

the user id

removeAddress

boolean removeAddress(DeviceAddress address)

Parameters:

address - the address to be removed from the device list

removeAllAddresses

void removeAllAddresses()

Empties the list of addresses

setName

void setName(java.lang.String name)

Parameters:

name - the name to set for the user device

toXML

org.w3c.dom.Element toXML(org.w3c.dom.Document doc)