com.abiquo.api.resources.BluetoothResource Class Reference

This class represents a BluetoothResource, and allows to interact with Bluetooth devices. More...

Inherits ResourceInstance.

List of all members.

Public Member Functions

BluetoothResource ()

Creates a new BluetoothResource with the default values.

BluetoothResource (ResourceInstance resourceInstance)

Creates a new BluetoothResource based on a generic ResourceInstance.

BluetoothResource (String name, InstanceName instanceName, List< Property > propertiesList)

Creates a new BluetoothResource based on the parameters.

Job friendlyNameInquiry ()

Creates a new Job which once executed, returns the list of friendly names for all the Bluetooth devices.

Job macInquiry ()

Creates a new Job which once executed, returns the list of MAC for all the Bluetooth devices.

Job sendFile (String mac, File file) throws IOException

Creates a new Job which once executed, sends a file through the Bluetooth device identified by the MAC address passed by parameter.

Static Public Member Functions

static BluetoothResource cast (ResourceInstance resourceInstance)

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

Static Public Attributes

static final String ID = "BluetoothResource"

String containing the identifier for this resource.

Detailed Description

This class represents a BluetoothResource, and allows to interact with Bluetooth devices.

Note:

XML description of the resource:

 <?xml version="1.0" encoding="utf-8"?>
 <Resource xmlns="http://www.abiquo.com/schema/Domain.xsd" LocalId="BluetoothResource">
  		<FunctionalityList> 
  			<Functionality LocalId="inquiry">
  				<AttributeList>
            		<Attribute Name="Type" Type="String" />
            	</AttributeList>
           </Functionality>
         	<Functionality LocalId="sendfile">
         		<AttributeList>
         			<Attribute Name="Input" Type="DataReference" />
         			<Attribute Name="MAC" Type="String" />
         		</AttributeList>
         	</Functionality>
		</FunctionalityList> 
 </Resource>

Constructor & Destructor Documentation

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

Creates a new BluetoothResource based on a generic ResourceInstance.

Parameters:

resourceInstance

The generic ResourceInstance

com.abiquo.api.resources.BluetoothResource.BluetoothResource	(	String	name,
		InstanceName	instanceName,
		List< Property >	propertiesList
	)

Creates a new BluetoothResource based on the parameters.

Parameters:

	name	The name of the resource
	instanceName	An InstanceName
	propertiesList	Properties list

Member Function Documentation

static BluetoothResource com.abiquo.api.resources.BluetoothResource.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.BluetoothResource.friendlyNameInquiry ( )

Creates a new Job which once executed, returns the list of friendly names for all the Bluetooth devices.

Returns:: The Job containing information about the demand

Job com.abiquo.api.resources.BluetoothResource.macInquiry ( )

Creates a new Job which once executed, returns the list of MAC for all the Bluetooth devices.

Returns:: The Job containing information about the demand

Job com.abiquo.api.resources.BluetoothResource.sendFile	(	String	mac,
		File	file
	)			throws IOException

Creates a new Job which once executed, sends a file through the Bluetooth device identified by the MAC address passed by parameter.

Parameters:

	mac	The MAC address of the Bluetooth device
	file	The file to send

Returns:: The Job containing information of the demand

Exceptions:

IOException

Signals that an I/O exception has occurred.

Member Data Documentation

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

src/com/abiquo/api/resources/BluetoothResource.java


Public Member Functions
	BluetoothResource ()
	Creates a new BluetoothResource with the default values.
	BluetoothResource (ResourceInstance resourceInstance)
	Creates a new BluetoothResource based on a generic ResourceInstance.
	BluetoothResource (String name, InstanceName instanceName, List< Property > propertiesList)
	Creates a new BluetoothResource based on the parameters.
Job	friendlyNameInquiry ()
	Creates a new Job which once executed, returns the list of friendly names for all the Bluetooth devices.
Job	macInquiry ()
	Creates a new Job which once executed, returns the list of MAC for all the Bluetooth devices.
Job	sendFile (String mac, File file) throws IOException
	Creates a new Job which once executed, sends a file through the Bluetooth device identified by the MAC address passed by parameter.
Static Public Member Functions
static BluetoothResource	cast (ResourceInstance resourceInstance)
	Converts a generic ResourceInstance into a new one of type BluetoothResource.
Static Public Attributes
static final String	ID = "BluetoothResource"
	String containing the identifier for this resource.