oracle.panama.model
Interface DeviceAddress

All Superinterfaces:

ModelObject, XMLObject

public interface DeviceAddress

extends ModelObject

A DeviceAddress is the device specific address like a phone or e-mail address.

Field Summary

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

Method Summary

boolean	decrementAlertSent() Decrements the daily counter for number of alerts sent
java.lang.String	getAddress() Gets the address property value
int	getAlertSent()
AuthLevel	getAuthLevel() Gets the Auth Level, for the authentication level (High, Medium, Low) used to automatically set up the user's session.
java.lang.String	getCarrier() Gets the carrier property value
java.lang.String	getControlNumber() Gets the control number
DeliveryType	getDeliveryType() Gets the deliveryType property value
java.lang.String	getDeviceId() Gets the Device Id
int	getMaxAlerts()
java.lang.String	getModel() Gets the model property value
java.lang.String	getName() Gets the name property value
java.lang.String	getNormalizedAddress() Gets the normailized address
User	getUser() Gets the user property value
UserDevice	getUserDevice() Get the user device that owns the device address.
boolean	incrementAlertSent() Increments the daily counter for number of alerts sent
boolean	isValid() Is the device address valid?
void	setAddress(DeliveryType deliveryType, java.lang.String address) Sets the address property value
void	setAuthLevel(AuthLevel authLevel) Sets the Auth level for the device.
void	setCarrier(java.lang.String carrier) Sets the carrier property value
void	setDeviceId(java.lang.String deviceId) Sets the Device Id property value
void	setMaxAlerts(int maxAlerts) Sets the maxAlerts property value
void	setModel(java.lang.String model) Sets the model property value
void	setName(java.lang.String name) Sets the name property value
void	setUser(User user) Sets the user propery value
void	setUserDevice(UserDevice device) Sets the user device that owns the device address.
boolean	validate(java.lang.String controlNumber) Validate the device address

Methods inherited from interface oracle.panama.model.ModelObject

delete, getCreatedDate, getId, getLastModifiedDate, getTypeId, getTypeName, isSystem, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

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

getName

public java.lang.String getName()

Gets the name property value

Specified by:

getName in interface ModelObject

Returns:

name of the device address

setName

public void setName(java.lang.String name)

Sets the name property value

Specified by:

setName in interface ModelObject

Parameters:

name - the new (name) property value

getUser

public User getUser()

Gets the user property value

Returns:

the User

setUser

public void setUser(User user)

Sets the user propery value

Parameters:

user - the new (user) property value

getMaxAlerts

public int getMaxAlerts()

Returns:

the maximum number of alert message the device address can receive

setMaxAlerts

public void setMaxAlerts(int maxAlerts)

Sets the maxAlerts property value

Parameters:

maxAlerts - the new property value

incrementAlertSent

public boolean incrementAlertSent()

Increments the daily counter for number of alerts sent

Returns:

true if the operation is succesful, will return false if alert sent >= max alerts

decrementAlertSent

public boolean decrementAlertSent()

Decrements the daily counter for number of alerts sent

Returns:

true if the operation is succesful, will return false if alert sent is already 0

getAlertSent

public int getAlertSent()

Returns:

number of alerts sent on this device today

getCarrier

public java.lang.String getCarrier()

Gets the carrier property value

setCarrier

public void setCarrier(java.lang.String carrier)

Sets the carrier property value

Parameters:

carrier - the new property value

getDeliveryType

public DeliveryType getDeliveryType()

Gets the deliveryType property value

Returns:

the delivery type property value

getAddress

public java.lang.String getAddress()

Gets the address property value

Returns:

the address

setAddress

public void setAddress(DeliveryType deliveryType,
                       java.lang.String address)

Sets the address property value

Parameters:

address - the address

deliveryType - the new property value

getNormalizedAddress

public java.lang.String getNormalizedAddress()

Gets the normailized address

Returns:

the normalized Address

getModel

public java.lang.String getModel()

Gets the model property value

Returns:

the device model

setModel

public void setModel(java.lang.String model)

Sets the model property value

Parameters:

model - the model of the device

getControlNumber

public java.lang.String getControlNumber()

Gets the control number

Returns:

the control number

validate

public boolean validate(java.lang.String controlNumber)

Validate the device address

Parameters:

controlNumber - the control number

Returns:

true if the validation was successful

isValid

public boolean isValid()

Is the device address valid?

Returns:

true if the device address is already validated

getDeviceId

public java.lang.String getDeviceId()

Gets the Device Id

Returns:

the Device Id

setDeviceId

public void setDeviceId(java.lang.String deviceId)

Sets the Device Id property value

setAuthLevel

public void setAuthLevel(AuthLevel authLevel)

Sets the Auth level for the device.

getAuthLevel

public AuthLevel getAuthLevel()

Gets the Auth Level, for the authentication level (High, Medium, Low) used to automatically set up the user's session.

Returns:

the authentication Level of the device

getUserDevice

public UserDevice getUserDevice()

Get the user device that owns the device address.

Returns:

the owner user device

setUserDevice

public void setUserDevice(UserDevice device)

Sets the user device that owns the device address.