com.ibm.mfp.server.registration.external.model

Class DeviceData

java.lang.Object

com.ibm.mfp.server.registration.external.model.DeviceData

public class DeviceData
extends java.lang.Object

This class manages information about the mobile device.

Constructor Summary

Constructors

Constructor and Description
DeviceData() Reserved for internal use only.
DeviceData(java.lang.String id, java.lang.String hardware, java.lang.String platform) Reserved for internal use only.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDisplayName() Returns the display name of the device. The initial display name is null.
java.lang.String	getHardware() Returns the hardware of the device.
java.lang.String	getId() Returns the unique ID of the device.
java.lang.String	getPlatform() Returns the name of the operating system of the device.
MFPDeviceStatus	getStatus() Returns the status of the device.
void	setDisplayName(java.lang.String displayName) Sets the display name of the device. Note that adapters must call AdapterSecurityContext.storeClientRegistrationData to store changes in the registration data, such as the device display name.
void	setStatus(MFPDeviceStatus deviceStatus) Sets the status of the device. Note that adapters must call AdapterSecurityContext.storeClientRegistrationData to store changes in the registration data, such as the device status.
boolean	updateFrom(DeviceData that) Reserved for internal use.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceData

public DeviceData()

Reserved for internal use only.

DeviceData

public DeviceData(java.lang.String id,
          java.lang.String hardware,
          java.lang.String platform)

Reserved for internal use only.

Parameters:

id - Unique device ID

hardware - Device hardware

platform - Device platform

Method Detail

updateFrom

public boolean updateFrom(DeviceData that)
                   throws java.lang.Exception

Reserved for internal use.

Parameters:

that -

Returns:

Throws:

java.lang.Exception

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getId

public java.lang.String getId()

Returns the unique ID of the device. The ID is assigned by MobileFirst Server.

Returns:

The unqiue device ID.

getHardware

public java.lang.String getHardware()

Returns the hardware of the device.

Returns:

The device hardware.

getPlatform

public java.lang.String getPlatform()

Returns the name of the operating system of the device.

Returns:

The name of the device operating system.

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of the device.
The initial display name is null. The display name can be set by the client application, or by calling the DeviceData.setDisplayName(java.lang.String) method of this class.

Returns:

The device display name.

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name of the device.
Note that adapters must call AdapterSecurityContext.storeClientRegistrationData to store changes in the registration data, such as the device display name.

Parameters:

displayName - Device display name to set.

setStatus

public void setStatus(MFPDeviceStatus deviceStatus)

Sets the status of the device.
Note that adapters must call AdapterSecurityContext.storeClientRegistrationData to store changes in the registration data, such as the device status.

Parameters:

deviceStatus - Device status to set.

getStatus

public MFPDeviceStatus getStatus()

Returns the status of the device.

Returns:

The device status.