com.ibm.rfid.premises.entities
Class Device

java.lang.Object
  extended by DeviceBase
      extended by com.ibm.rfid.premises.entities.Device

public class Device
extends DeviceBase

Device is the class used to describe a configured Device object for the IBM WebSphere Sensor Events Server. This class provides access to the following Device properties:

The above properties are read-only. Although they are settable using the setter functions described below, they only affect the data stored in this class instance and should only be used by the PremisesAccess class to create Device objects found on the IBM WebSphere Sensor Events Server.

To define a reader, go to the IBM WebSphere Sensor Events Server Admin Console


Constructor Summary
Device(DeviceBase device)
          Base constructor, used by PremisesAccess
 
Method Summary
 java.lang.String getCategory()
          Gets the category name of the device
 java.lang.String getConfigGrp()
          Gets the Device's Configuration Group
 java.lang.String getDeviceId()
          Gets the Device's ID
 java.lang.String getLocationId()
          Gets the Device's Location ID
 java.util.HashMap getMetadata()
          Retruns devie metadata object collection as HashMap
 java.lang.String getStatus()
          Gets the device's most recent status
 java.lang.String getUserName()
          Gets the user name of the Device
 void start()
          sends a start command to the location of the device
 void stop()
          sends stop command to location of device
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Device

public Device(DeviceBase device)
Base constructor, used by PremisesAccess

Method Detail

start

public void start()
sends a start command to the location of the device

Throws:
PremisesAccessException

getMetadata

public java.util.HashMap getMetadata()
Retruns devie metadata object collection as HashMap

Returns:
HashMap of MetaData Objcet

stop

public void stop()
sends stop command to location of device

Throws:
PremisesAccessException

getUserName

public java.lang.String getUserName()
Gets the user name of the Device

Returns:
a String representing user name of Device

getStatus

public java.lang.String getStatus()
Gets the device's most recent status

Returns:
a String representing the Device's most recent status.
Throws:
PremisesAccessException

getConfigGrp

public java.lang.String getConfigGrp()
Gets the Device's Configuration Group

Returns:
a String representing the Device's Confguration Group

getDeviceId

public java.lang.String getDeviceId()
Gets the Device's ID

Returns:
a String representing the Device's ID

getLocationId

public java.lang.String getLocationId()
Gets the Device's Location ID

Returns:
a String representing the Device's Location ID

getCategory

public java.lang.String getCategory()
Gets the category name of the device

Returns:
a String representing the Reader object's category name property


Copyright © 2005 - 2009 IBM Corp. All Rights Reserved.