com.zebra.sdk.zmotif.job

Interface JobUtilZmotif

All Known Subinterfaces:

ZebraPrinterZmotif

public interface JobUtilZmotif

Interface for job related tasks and information.

Method Summary

Methods

Modifier and Type	Method and Description
void	abort(boolean reject) Aborts a print job.
ReservationInfo	getReservationStatus(int reservationToken) Queries the printer and returns the current status of the printer from the supplied reservation token.
java.util.List<String>	getTestPrintImageNames() Queries the printer and returns a list of available test print image names. ZC Series printers only.
ReservationInfo	isDeviceInSession() Queries the printer and returns whether the printer is currently in session.
int	printTestCard(byte imageNumber, int copies, boolean dualSided) Prints the specified test image. ZMotif series 7, 8, and 9 printers only.
void	printTestCard(String testPrintName) Prints the specified test image. ZC Series printers only.
BarcodeReadInfo	readBarcodeData() Sends a job to the printer to scan and return the barcode data from a card.
void	reject() Rejects a card from the printer's home position.
void	releaseDeviceReservation(int reservationToken) Releases the reservation session associated with the reservationToken.
int	reserveDevice(ReservationType type) Requests a reservation to a shared printer.
void	retrySmartCard(SmartCardType type) Repositions a smart card that is already present at the encoder.

Method Detail

abort

void abort(boolean reject)
           throws ConnectionException,
                  ZebraCardException

Aborts a print job.

Parameters:

reject -

• True = abort the job and send the card to the reject bin.
• False = abort the job and hold the card in the printer's home position.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

ZebraCardException - if a printer error occurs.

getReservationStatus

ReservationInfo getReservationStatus(int reservationToken)
                                     throws ConnectionException,
                                            ZebraCardException,
                                            ZebraIllegalArgumentException

Queries the printer and returns the current status of the printer from the supplied reservation token.

Parameters:

reservationToken - printer's supplied reservation token.

Returns:

a ReservationInfo instance containing the status of the device reservation.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

ZebraCardException - if a printer error occurs.

ZebraIllegalArgumentException - if the reservationToken is invalid.

isDeviceInSession

ReservationInfo isDeviceInSession()
                                  throws ConnectionException,
                                         ZebraCardException

Queries the printer and returns whether the printer is currently in session.

Returns:

a ReservationInfo instance containing the status of the device reservation.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

ZebraCardException - if a printer error occurs.

readBarcodeData

BarcodeReadInfo readBarcodeData()
                                throws ConnectionException,
                                       SettingsException,
                                       ZebraCardException,
                                       java.util.concurrent.TimeoutException

Sends a job to the printer to scan and return the barcode data from a card.

Returns:

a BarcodeReadInfo instance containing the barcode type and data read from the card.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

SettingsException - if an error occurs while reading the barcode data.

java.util.concurrent.TimeoutException - if the operation times out before it completes.

ZebraCardException - if a printer error occurs.

reject

void reject()
            throws ConnectionException,
                   ZebraCardException

Rejects a card from the printer's home position.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

ZebraCardException - if a printer error occurs.

releaseDeviceReservation

void releaseDeviceReservation(int reservationToken)
                              throws ConnectionException,
                                     ZebraCardException,
                                     ZebraIllegalArgumentException

Releases the reservation session associated with the reservationToken.

Parameters:

reservationToken - printer's supplied reservation token.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

ZebraCardException - if a printer error occurs.

ZebraIllegalArgumentException - if the reservationToken is invalid.

retrySmartCard

void retrySmartCard(SmartCardType type)
                    throws ConnectionException,
                           SettingsException,
                           ZebraCardException,
                           ZebraIllegalArgumentException

Repositions a smart card that is already present at the encoder.

Parameters:

type - the type of smart card.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

SettingsException - if an error occurs while repositioning the smart card.

ZebraCardException - if a printer error occurs.

ZebraIllegalArgumentException - if the type is invalid.

reserveDevice

int reserveDevice(ReservationType type)
                  throws ConnectionException,
                         ZebraCardException

Requests a reservation to a shared printer.

Parameters:

type - the type of reservation to request.

Returns:

the printer's supplied reservation token.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

ZebraCardException - if a printer error occurs.

printTestCard

int printTestCard(byte imageNumber,
                int copies,
                boolean dualSided)
                  throws ConnectionException,
                         ZebraCardException,
                         ZebraIllegalArgumentException

Prints the specified test image.
ZMotif series 7, 8, and 9 printers only.

Parameters:

imageNumber - test image number.

copies - number of copies to print.

dualSided - true indicates the test image should be printed dual sided.

Returns:

the assigned job ID.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

ZebraCardException - if the printer model is not supported or a printer error occurs.

ZebraIllegalArgumentException - if the imageNumber, copies, or dualSided are invalid.

getTestPrintImageNames

java.util.List<String> getTestPrintImageNames()
                                              throws ConnectionException,
                                                     SettingsException,
                                                     ZebraCardException

Queries the printer and returns a list of available test print image names.
ZC Series printers only.

Returns:

a list of the available test print image names.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

SettingsException - if an error occurs while retrieving the test print image names.

ZebraCardException - if the printer model is not supported or a printer error occurs.

printTestCard

void printTestCard(String testPrintName)
                   throws ConnectionException,
                          ZebraCardException,
                          ZebraIllegalArgumentException

Prints the specified test image.
ZC Series printers only.

Parameters:

testPrintName - test print image name.

• Use getTestPrintImageNames() to retrieve the list of available test print image names.

Throws:

ConnectionException - if the device is busy or there is a error communicating with the printer.

ZebraCardException - if the printer model is not supported or a printer error occurs.

ZebraIllegalArgumentException - if testPrintName is invalid.