com.ibm.rfid.premises.entities
Class Location

java.lang.Object
  extended by LocationBase
      extended by com.ibm.rfid.premises.entities.Location

public class Location
extends LocationBase

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

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


Constructor Summary
Location(LocationBase location)
          Base constructor, used by PremisesAccess
 
Method Summary
 java.lang.String getAlias()
          Gets the Alias name of the Location
 java.lang.String getCategory()
          Gets the category name of the device
 java.lang.String getChildLocationID()
           
 java.lang.String getConfigGrp()
          Gets the Location Configuration Group
 java.lang.String[] getDeviceId()
          Gets the Device ID associated with the Location
 java.lang.String getLocationId()
          Gets the Location ID
 java.util.HashMap getMetadata()
          Gets devie metadata object as HashMap.
 java.lang.String getParent()
          Gets the Parent Location name of the Location
 java.lang.String getUserName()
          Gets the user name of the Location
 boolean isContainerLocation()
          Gets the boolean value if given location is container Location
 void setChildLocationID(java.lang.String locationid)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Location

public Location(LocationBase location)
Base constructor, used by PremisesAccess

Method Detail

getMetadata

public java.util.HashMap getMetadata()
                              throws PremisesAccessException
Gets devie metadata object as HashMap.

Returns:
HashMap of Location MetaData Object
Throws:
PremisesAccessException

getUserName

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

Returns:
a String representing user name of Location

getAlias

public java.lang.String getAlias()
Gets the Alias name of the Location

Returns:
a String representing Alias name of Location

getParent

public java.lang.String getParent()
Gets the Parent Location name of the Location

Returns:
a String representing Parent location name of Location

getDeviceId

public java.lang.String[] getDeviceId()
Gets the Device ID associated with the Location

Returns:
a String array representing Device ID's associated with the location

isContainerLocation

public boolean isContainerLocation()
Gets the boolean value if given location is container Location

Returns:
boolean value if current location is container location or not

getConfigGrp

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

Returns:
a String representing the Location Confguration Group

getLocationId

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

Returns:
a String representing the Location ID

getCategory

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

Returns:
a String representing the locations category name

setChildLocationID

public void setChildLocationID(java.lang.String locationid)

getChildLocationID

public java.lang.String getChildLocationID()


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