com.abiquo.api.resources.PrinterResource Class Reference

This class represents a PrinterResource, and allows to get the printers listing, and to print a document in an specific printer from the list. More...

Inherits ResourceInstance.

List of all members.

Public Member Functions
	PrinterResource ()
	Creates a new PrinterResource with the default values.
	PrinterResource (ResourceInstance resourceInstance)
	Creates a new PrinterResource based on a generic ResourceInstance.
Job	getPrinterList ()
	Creates a new Job which once executed, returns the list of printers on the network.
Job	print (String printerId, File documentToPrint) throws IOException
	Creates a new Job which once executed, prints a document on the printer passed as parameter.
Static Public Member Functions
static PrinterResource	cast (ResourceInstance resourceInstance)
	Converts a generic ResourceInstance into a new one of type PrinterResource.
Static Public Attributes
static final String	ID = "Printer"
	String containing the identifier for this resource.

---

Detailed Description

This class represents a PrinterResource, and allows to get the printers listing, and to print a document in an specific printer from the list.

---

Constructor & Destructor Documentation

com.abiquo.api.resources.PrinterResource.PrinterResource

(

ResourceInstance

resourceInstance

)

Creates a new PrinterResource based on a generic ResourceInstance.

Parameters:

resourceInstance

The generic ResourceInstance

---

Member Function Documentation

static PrinterResource com.abiquo.api.resources.PrinterResource.cast

(

ResourceInstance

resourceInstance

)

[static]

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

Parameters:

resourceInstance

The generic ResourceInstance

Returns:

The resultant PrinterResource

Job com.abiquo.api.resources.PrinterResource.getPrinterList

(

)

Creates a new Job which once executed, returns the list of printers on the network.

Returns:

The Job to perform the demand

Job com.abiquo.api.resources.PrinterResource.print	(	String	printerId,
		File	documentToPrint
	)			throws IOException

Creates a new Job which once executed, prints a document on the printer passed as parameter.

Parameters:

	printerId	the printer id
	documentToPrint	the document to print

Returns:

The Job to perform the demand

Exceptions:

IOException

Signals that an I/O exception has occurred.

---

Member Data Documentation

final String com.abiquo.api.resources.PrinterResource.ID = "Printer" [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/PrinterResource.java