com.abiquo.api.resources.CameraResource Class Reference

This class represents a CameraResource, and allows to grab pictures from a Wireless camera. More...

Inherits ResourceInstance.

List of all members.

Public Member Functions

 CameraResource ()
 Creates a new CameraResource with the default values.
 CameraResource (ResourceInstance resourceInstance)
 Creates a new CameraResource based on a generic ResourceInstance.
Job captureImage ()
 Creates a new Job which once executed, retrieves an image from the Wireless camera.

Static Public Member Functions

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

Static Public Attributes

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


Detailed Description

This class represents a CameraResource, and allows to grab pictures from a Wireless camera.

Note:
XML description of the resource:
 <Resource xmlns="http://www.abiquo.com/schema/Domain.xsd" LocalId="Camera">
	<FunctionalityList>
		<Functionality LocalId="captureImage" ReturnType="void" />
	</FunctionalityList>
 </Resource>
 

Constructor & Destructor Documentation

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

Creates a new CameraResource based on a generic ResourceInstance.

Parameters:
resourceInstance The generic ResourceInstance


Member Function Documentation

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

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

Parameters:
resourceInstance The generic ResourceInstance
Returns:
The resultant CameraResource

Job com.abiquo.api.resources.CameraResource.captureImage (  ) 

Creates a new Job which once executed, retrieves an image from the Wireless camera.

Returns:
The Job containing information about the demand


Member Data Documentation

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