oracle.panama.model
Interface UserDevice

public interface UserDevice

Interface for UserDevice.

Field Summary

static int	TYPEID The type id of this class.
static java.lang.String	TYPENAME The constant class type identifier.

Method Summary

void	addDeviceAddress(DeviceAddress deviceAddress) Add a device address to this user device.
DeviceAddress	getDefaultDeviceAddress() Gets the default device address for this user device.
DeviceAddress[]	getDeviceAddresses() Retrieves the current list of device addresses for the user who owns this UserDevice.
DeviceType	getDeviceType() Get type of the user device.
java.lang.String	getDisplayName() Get the display name of the device.
java.lang.String	getEncoding() Gets the default encoding for the user device.
long	getId() Return the id of the user device
int	getMaxNumAlerts() Gets the maximum number alerts that can be sent from the user device per day.
java.lang.String	getName() Get the name of the user device.
java.lang.String	getNickName() Deprecated.
PhysicalDevice	getPhysicalDevice() Retrieve the physical device that corresponds to this device.
int	getPreference() Returns the preference of the user device.
java.lang.String	getTypeName() Return the type of the user device.
User	getUser() Return the user who owns this device.
Profile	getUserProfile() Gets the user profile that's set for this device specifically.
DeviceAddress[]	lookupDeviceAddress(DeliveryType deliveryType) Look up the device address by delivery type.
DeviceAddress	lookupDeviceAddress(java.lang.String name) Look up a device address by name from the user device.
void	removeDeviceAddress(DeviceAddress deviceAddress) Remove a device address from this user device.
void	setDefaultDeviceAddress(DeviceAddress deviceAddress) Sets the default device address for this user device.
void	setDeviceType(DeviceType type) Sets the type of the user device.
void	setDisplayName(java.lang.String displayName) Sets the nick name property value
void	setEncoding(java.lang.String encoding) Sets the default encoding for the user device.
void	setMaxNumAlerts(int maxAlerts) Sets the maximum number alerts that can be sent from the user device per day.
void	setName(java.lang.String name) Sets the name of the user device.
void	setNickName(java.lang.String name) Sets the name of the user device.
void	setPhysicalDevice(PhysicalDevice physicalDevice) Set the physical device that mappes to the user device.
void	setPreference(int preference) Set the preference value for the user device.
void	setUser(User user) Set the user who owns the device.
void	setUserProfile(Profile userProfile) Sets the user profile for this device specfic view customization.

Field Detail

TYPENAME

public static final java.lang.String TYPENAME

The constant class type identifier.

See Also:

Constant Field Values

TYPEID

public static final int TYPEID

The type id of this class.

See Also:

Constant Field Values

Method Detail

getId

public long getId()

Return the id of the user device

Returns:

the id of the device

getTypeName

public java.lang.String getTypeName()

Return the type of the user device.

Returns:

the type name of user device.

getDeviceAddresses

public DeviceAddress[] getDeviceAddresses()

Retrieves the current list of device addresses for the user who owns this UserDevice.

Returns:

An array of DeviceAddresss.

setDefaultDeviceAddress

public void setDefaultDeviceAddress(DeviceAddress deviceAddress)

Sets the default device address for this user device.

Parameters:

deviceAddress - the device address

getDefaultDeviceAddress

public DeviceAddress getDefaultDeviceAddress()

Gets the default device address for this user device.

Returns:

The default device address or null if there is no device address.

removeDeviceAddress

public void removeDeviceAddress(DeviceAddress deviceAddress)

Remove a device address from this user device.

Parameters:

deviceAddress - the device address to be removed.

addDeviceAddress

public void addDeviceAddress(DeviceAddress deviceAddress)

Add a device address to this user device.

Parameters:

deviceAddress - the new device address

lookupDeviceAddress

public DeviceAddress lookupDeviceAddress(java.lang.String name)

Look up a device address by name from the user device.

Parameters:

name - the name of the device address

Returns:

the device address

getPhysicalDevice

public PhysicalDevice getPhysicalDevice()

Retrieve the physical device that corresponds to this device.

Returns:

corresponding physical device

setPhysicalDevice

public void setPhysicalDevice(PhysicalDevice physicalDevice)

Set the physical device that mappes to the user device.

Parameters:

physicalDevice - physical device

getUser

public User getUser()

Return the user who owns this device.

Returns:

the owner of the device

setUser

public void setUser(User user)

Set the user who owns the device.

Parameters:

user - owner of the device

getName

public java.lang.String getName()

Get the name of the user device. The name of the user device is used for internal purpose as opposed to display name which is used for display purpose.

setName

public void setName(java.lang.String name)

Sets the name of the user device. The name of the user device is used for internal purpose as opposed to display name which is used for display purpose.

getNickName

public java.lang.String getNickName()

Deprecated.

Get the name of the user device. The name of the user device is used for internal purpose as opposed to display name which is used for display purpose.

setNickName

public void setNickName(java.lang.String name)

Sets the name of the user device. The name of the user device is used for internal purpose as opposed to display name which is used for display purpose.

getDisplayName

public java.lang.String getDisplayName()

Get the display name of the device.

Returns:

display name of the device

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the nick name property value

Parameters:

displayName - the new (nick name) property value

getDeviceType

public DeviceType getDeviceType()

Get type of the user device.

Returns:

the type of the user device.

setDeviceType

public void setDeviceType(DeviceType type)

Sets the type of the user device.

Parameters:

type - The type of the user device

getUserProfile

public Profile getUserProfile()

Gets the user profile that's set for this device specifically. Could be null if none is set.

Returns:

the user (view) profile for this device.

setUserProfile

public void setUserProfile(Profile userProfile)

Sets the user profile for this device specfic view customization. The parameter userProfile can not be null.

Parameters:

userProfile -

getPreference

public int getPreference()

Returns the preference of the user device.

Returns:

The preference of the user device.

setPreference

public void setPreference(int preference)

Set the preference value for the user device.

Parameters:

preference - The preference value of the user device. Has to be non-negative.

Throws:

java.lang.IllegalArgumentException - if the preference parameter is negative.

getEncoding

public java.lang.String getEncoding()

Gets the default encoding for the user device.

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the default encoding for the user device.

lookupDeviceAddress

public DeviceAddress[] lookupDeviceAddress(DeliveryType deliveryType)

Look up the device address by delivery type. Could be an array of delivery addresses, e.g., in case of multiple carriers on the same device.

getMaxNumAlerts

public int getMaxNumAlerts()

Gets the maximum number alerts that can be sent from the user device per day.

Returns:

the maximum number alerts that can be sent from the user device per day.

setMaxNumAlerts

public void setMaxNumAlerts(int maxAlerts)

Sets the maximum number alerts that can be sent from the user device per day.

Parameters:

maxAlerts - the maximum number alerts that can be sent from the user device per day.