com.ibm.rfid.premises.entities
Class Controller

java.lang.Object
  extended by ControllerBase
      extended by com.ibm.rfid.premises.entities.Controller

public class Controller
extends ControllerBase

Controller is the class used to describe a configured Controller object on an IBM WebSphere Sensor Events. This class provides access to the following Controller 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 Controller objects found on the IBM WebSphere Sensor Events Server.

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


Constructor Summary
Controller(ControllerBase controller)
          Base constructor, used by PremisesAccess
 
Method Summary
 java.lang.String getCategory()
          Gets the category name of the Configuration Group for the given Controller ID
 java.lang.String getConfigGrp()
          Gets the Controller Configuration Group
 java.lang.String getControllerId()
          Gets the Controller unique ID
 java.lang.String[] getLocationId()
          Gets the String Array of Location ID's for the Controller
 java.util.HashMap getMetadata()
          Gets the Metadata Object for the Controler ID
 java.lang.String getUserName()
          Gets the user name of the Controller
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Controller

public Controller(ControllerBase controller)
Base constructor, used by PremisesAccess

Method Detail

getMetadata

public java.util.HashMap getMetadata()
                              throws PremisesAccessException
Gets the Metadata Object for the Controler ID

Returns:
Controller's metadata object as HashMap.
Throws:
PremisesAccessException

getUserName

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

Returns:
a String representing the User Name of Controller ID.

getConfigGrp

public java.lang.String getConfigGrp()
Gets the Controller Configuration Group

Returns:
a String representing the Confguration Group Name of Controller ID.

getControllerId

public java.lang.String getControllerId()
Gets the Controller unique ID

Returns:
a String representing the Controller's unique ID

getLocationId

public java.lang.String[] getLocationId()
Gets the String Array of Location ID's for the Controller

Returns:
a String Array representing the location id's for given Controller ID

getCategory

public java.lang.String getCategory()
Gets the category name of the Configuration Group for the given Controller ID

Returns:
a String representing the category name of Controller ID


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