oracle.ucs.userprefs

Interface DeviceAddress

All Superinterfaces:

MetaData, Serializable, UserPrefsObject

public interface DeviceAddress
extends UserPrefsObject, MetaData

This interface represents a physical device.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAddress() Gets the address string (e.g.
String	getCarrier() Gets the name of carrier of this device.
String	getDeliveryMode() Gets optional delivery mode of this address.
DeliveryType	getDeliveryType() Gets delivery type of this device.
String	getDescription() Gets the description of the device.
String	getEncoding() Gets encoding of the device.
String	getName() Gets the name of this device.
String	getReferenceKey() Gets the reference key of an indirect address.
DeviceAddressType	getType() Gets the type of this DeviceAddress object.
String	getUserID() Gets user ID of this device address.
void	setAddress(String addr) Sets address string (e.g.
void	setCarrier(String carrier) Sets the name of carrier of this device.
void	setDeliveryMode(String deliveryMode) Sets optional delivery mode of this address.
void	setDeliveryType(DeliveryType deliveryType) Sets delivery type (e.g.
void	setDescription(String desc) Sets an optional description of the string.
void	setEncoding(String encoding) Sets encoding of the device.
void	setReferenceKey(String refKey) Set reference key of an IDM address.
void	setType(DeviceAddressType deviceAddressType) Sets type of this address.
String	toExternalFormat() Returns a normalized string representation of this address in <DeliveryType>:<address> format.

Methods inherited from interface oracle.ucs.userprefs.UserPrefsObject

getCreatedDate, getLastModifiedDate, getVersion, isValid, setValid

Methods inherited from interface oracle.ucs.userprefs.MetaData

getAllNamespaces, getMetaData, getMetaDataNames, setMetaData

Method Detail

getUserID

String getUserID()

Gets user ID of this device address.

Returns:

userID of this device address.

getName

String getName()

Gets the name of this device.

Returns:

the name of the device address

getType

DeviceAddressType getType()

Gets the type of this DeviceAddress object. address repository or in another ID management server (i.e. LDAP).

Returns:

a DeviceAddressType object which may have following values: UCP: this address is locally stored in UCP repository. IDM: This is an indirect address which is stored in an identity management server (i.e. LDAP). DEFAULT_REFERENCE: This is a reference of a default device address.

setType

void setType(DeviceAddressType deviceAddressType)

Sets type of this address.

Parameters:

deviceAddressType - a DeviceAddressType object.

getReferenceKey

String getReferenceKey()

Gets the reference key of an indirect address.

Returns:

Reference key of the address.

setReferenceKey

void setReferenceKey(String refKey)

Set reference key of an IDM address.

Parameters:

refKey - reference key of an IDM address.

setDeliveryMode

void setDeliveryMode(String deliveryMode)

Sets optional delivery mode of this address. Delivery modes of email channel are: TO, CC and BCC

Parameters:

deliveryMode - Delivery mode string.

getDeliveryMode

String getDeliveryMode()

Gets optional delivery mode of this address.

Returns:

A channel specific delivery mode string. Delivery modes of email channel are TO CC and BCC.

getAddress

String getAddress()

Gets the address string (e.g. an email address or a phone number) of this device object.

Returns:

the address string.

setAddress

void setAddress(String addr)

Sets address string (e.g. an email address or a phone number) to this device.

Parameters:

addr - the address to be set

setDeliveryType

void setDeliveryType(DeliveryType deliveryType)

Sets delivery type (e.g. EMAIL, VOICE, SMS, FAX) of this device.

Parameters:

deliveryType - used to set the delivery type channel

getDeliveryType

DeliveryType getDeliveryType()

Gets delivery type of this device.

Returns:

the delivery type

getCarrier

String getCarrier()

Gets the name of carrier of this device.

Returns:

the userprefs carrier the address is registered to

setCarrier

void setCarrier(String carrier)

Sets the name of carrier of this device.

Parameters:

carrier - the userprefs carrier to be set

getEncoding

String getEncoding()

Gets encoding of the device.

Returns:

the MIME encoding supported by this address

setEncoding

void setEncoding(String encoding)

Sets encoding of the device.

Parameters:

encoding - the MIME encoding to be set for this address

toExternalFormat

String toExternalFormat()

Returns a normalized string representation of this address in <DeliveryType>:<address> format. e.g. EMAIL:foo@bar.com

Returns:

a String representation of this address

getDescription

String getDescription()

Gets the description of the device.

Returns:

the description

setDescription

void setDescription(String desc)

Sets an optional description of the string.

Parameters:

desc - the description to be set