com.abiquo.api.resources.RFIDResource Class Reference

This class represents a RFIDResource, and allows to interact with a USB tags reader. More...

Inherits ResourceInstance.

List of all members.

Public Member Functions

 RFIDResource ()
 Creates a new RFIDResource with the default values.
 RFIDResource (ResourceInstance resourceInstance)
 Creates a new RFIDResource based on a generic ResourceInstance.
Job getLastTag ()
 Creates a new Job which once executed, returns the last read tag by the RFID device.
Job getTags ()
 Creates a new Job which once executed, returns a list of the read tags by the RFID device, and its dates.

Static Public Member Functions

static RFIDResource cast (ResourceInstance resourceInstance)
 Converts a generic ResourceInstance into a new one of type RFIDResource.

Static Public Attributes

static final String ID = "RFID"
 String containing the identifier for this resource.


Detailed Description

This class represents a RFIDResource, and allows to interact with a USB tags reader.

The functionalities returns an attribute list with the pair id and time for each read tag.

Note:
XML description of the resource:
   <Resource LocalId="RFID">
     <FunctionalityList>
       <Functionality LocalId="getLastTag" ReturnType="void">
       <Functionality LocalId="getTags"    ReturnType="void">
     </FunctionalityList>
   </Resource>
  
   <ResourceDemandRequest AbstractName="RFID" Session="0920438207" FunctionalityName="getTags"/>
  
   <ResourceDemandResponse Status = '3' Message = 'Ok.'>
     <DefinedAttributeList>
       <DefinedAttribute Name='Tag' Value='0x1400b6aa0c' />
       <DefinedAttribute Name='DateAndTime' Value='Wed Jun 18 10:11:26 2008' />
       <DefinedAttribute Name='Tag' Value='0x14005c7d72' />
       <DefinedAttribute Name='DateAndTime' Value='Wed Jun 18 10:11:29 2008' />
     </DefinedAttributeList>
   </ResourceDemandResponse>
   

Constructor & Destructor Documentation

com.abiquo.api.resources.RFIDResource.RFIDResource ( ResourceInstance  resourceInstance  ) 

Creates a new RFIDResource based on a generic ResourceInstance.

Parameters:
resourceInstance The generic ResourceInstance


Member Function Documentation

static RFIDResource com.abiquo.api.resources.RFIDResource.cast ( ResourceInstance  resourceInstance  )  [static]

Converts a generic ResourceInstance into a new one of type RFIDResource.

Parameters:
resourceInstance The generic ResourceInstance
Returns:
The resultant RFIDResource

Job com.abiquo.api.resources.RFIDResource.getLastTag (  ) 

Creates a new Job which once executed, returns the last read tag by the RFID device.

Returns:
The Job containing information about the demand

Job com.abiquo.api.resources.RFIDResource.getTags (  ) 

Creates a new Job which once executed, returns a list of the read tags by the RFID device, and its dates.

Returns:
The Job containing information about the demand


Member Data Documentation

final String com.abiquo.api.resources.RFIDResource.ID = "RFID" [static]

String containing the identifier for this resource.

Note:
To avoid misspellings when provision a resource, you should use this constant ID instead of a manually typed string.


The documentation for this class was generated from the following file:

Generated on Mon Sep 15 20:13:10 2008 for FrameworkAPI by  doxygen 1.5.5