com.abiquo.api.resources.ZigBeeResource Class Reference

This class represents a ZigBeeResource. More...

Inherits ResourceInstance.

List of all members.

Public Member Functions

 ZigBeeResource ()
 Creates a new ZigBeeResource with the default values.
 ZigBeeResource (ResourceInstance resourceInstance)
 Creates a new BluetoothResource based on a generic ResourceInstance.
Job addListener ()
 Creates a new Job which once executed, creates a new listener to be used by a Squid*Resource.
Job removeListener ()
 Creates a new Job which once executed, removes a listener.
Job start ()
 Creates a new Job which once executed, starts listening ZigBee devices.
Job stop ()
 Creates a new Job which once executed, stops listening ZigBee devices.

Static Public Member Functions

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

Static Public Attributes

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


Detailed Description

This class represents a ZigBeeResource.

It exposes methods to read from ZigBee devices trough the gateway.

 <?xml version="1.0" encoding="utf-8"?>
 <Resource xmlns:a="http://abiquo.com/schema/Domain.xsd" LocalId="ZigBeeResource">
   <FunctionalityList>
     <Functionality LocalId="Execute" ReturnType="void">
       <AttributeList>
         <Attribute Name="Session" Type="string" />
       </AttributeList>
     </Functionality>
     <Functionality LocalId="start" ReturnType="void"/>
     <Functionality LocalId="stop" ReturnType="void"/>
     <Functionality LocalId="addListener" ReturnType="string"/>
     <Functionality LocalId="RemoveListener" ReturnType="void">
       <AttributeList>
         <Attribute Name="session" Type="string" />
       </AttributeList>
     </Functionality>     
   </FunctionalityList>
 </Resource>
 

Constructor & Destructor Documentation

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

Creates a new BluetoothResource based on a generic ResourceInstance.

Parameters:
resourceInstance The generic ResourceInstance


Member Function Documentation

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

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

Parameters:
resourceInstance The generic ResourceInstance
Returns:
The resultant BluetoothResource

Job com.abiquo.api.resources.ZigBeeResource.addListener (  ) 

Creates a new Job which once executed, creates a new listener to be used by a Squid*Resource.

Returns:
The Job containing information about the demand

Job com.abiquo.api.resources.ZigBeeResource.removeListener (  ) 

Creates a new Job which once executed, removes a listener.

Returns:
The Job containing information about the demand

Job com.abiquo.api.resources.ZigBeeResource.start (  ) 

Creates a new Job which once executed, starts listening ZigBee devices.

Returns:
The Job containing information about the demand

Job com.abiquo.api.resources.ZigBeeResource.stop (  ) 

Creates a new Job which once executed, stops listening ZigBee devices.

Returns:
The Job containing information about the demand


Member Data Documentation

final String com.abiquo.api.resources.ZigBeeResource.ID = "ZigBee" [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