com.zebra.sdk.common.card.job

Interface JobUtil

All Known Subinterfaces:

ZebraCardPrinter, ZebraPrinterZmotif, ZebraPrinterZxp

public interface JobUtil

An interface used to define functions used in job related operations.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(int jobID) Cancels all jobs or a specific job.
void	destroy() Clean up all the resources and stop any running threads. ZXP Series 1/3: calling destroy with pending or active jobs will result in all jobs being canceled.
void	ejectCard() Sends the card to the eject bin.
java.util.List<JobStatus>	getJobList() Returns a list of all the current jobs in the printer's queue.
JobStatusInfo	getJobStatus(int jobId) Returns the job status for the specified jobId.
int	magEncode(int copies, String track1Data, String track2Data, String track3Data) Encodes a magnetic card for the current job.
int	positionCard() Moves a card from the specified source to the specified destination.
int	print(int copies, java.util.List<GraphicsInfo> graphicsData) Prints a card with the images provided.
int	printAndMagEncode(int copies, java.util.List<GraphicsInfo> graphicsData, String track1Data, String track2Data, String track3Data) Encodes the magnetic encoding data and prints a card with the images provided.
int	printTemplate(int copies, TemplateJob jobData) Prints a card with the provided template.
MagTrackData	readMagData(java.util.EnumSet<DataSource> tracksToRead) Reads the data from a magnetically encoded card.
MagTrackData	readMagData(java.util.EnumSet<DataSource> tracksToRead, boolean isVerbose) Reads the data from a magnetically encoded card.
void	reprint(int copies) Reprints the last rendered job.
void	resume() Resumes the processing of a held job such as a smart card encoding job.
void	setGraphics(ZebraGraphicsI zebraCardGraphics) Sets the zebraCardGraphics object.
int	smartCardEncode(int copies) Positions a card at the smartcard station, suspends the job to allow the card to be read or encoded, and waits for resume() to be called before completing the job.

Method Detail

cancel

void cancel(int jobID)
            throws ConnectionException,
                   ZebraCardException

Cancels all jobs or a specific job.

Parameters:

jobID - the ID of the job to cancel.

• Set jobID to '0' to cancel all jobs.

Throws:

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

ZebraCardException - if a printer error occurs.

ejectCard

void ejectCard()
               throws ConnectionException,
                      ZebraCardException

Sends the card to the eject bin.

• A smartcard encoding job is a separate activity and the card cannot be ejected from the encoder. The job must be resumed or aborted.

Throws:

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

ZebraCardException - if a printer error occurs.

getJobList

java.util.List<JobStatus> getJobList()
                                     throws ConnectionException,
                                            ZebraCardException

Returns a list of all the current jobs in the printer's queue.

• For ZXP Series printers this operation is only guaranteed with the current printer instance.

Returns:

List containing all the current jobs in the printer's queue.

Throws:

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

ZebraCardException - if a printer error occurs.

getJobStatus

JobStatusInfo getJobStatus(int jobId)
                           throws ConnectionException,
                                  ZebraCardException

Returns the job status for the specified jobId.

• For ZXP Series printers this operation is only guaranteed with the current printer instance.

Parameters:

jobId - ID number of the job.

Returns:

instance containing the requested job status information.

• ZXP Series printers will not report the card position.

Throws:

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

ZebraCardException - if a printer error occurs or jobId is invalid.

positionCard

int positionCard()
                 throws ConnectionException,
                        SettingsException,
                        ZebraCardException

Moves a card from the specified source to the specified destination.

• CardSource and CardDestination can be individually set prior to calling this method otherwise the default values of CardSource.Feeder and CardDestination.Eject will be used.

Returns:

the assigned job ID number.

Throws:

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

SettingsException - if the job settings are not valid.

ZebraCardException - if a printer error occurs.

magEncode

int magEncode(int copies,
            String track1Data,
            String track2Data,
            String track3Data)
              throws ConnectionException,
                     SettingsException,
                     ZebraCardException

Encodes a magnetic card for the current job.

Parameters:

copies - number of copies to be printed.

track1Data - data to be encoded on track 1.

track2Data - data to be encoded on track 2.

track3Data - data to be encoded on track 3.

Returns:

the assigned job ID number.

Throws:

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

SettingsException - if the job settings are not valid.

ZebraCardException - if a printer error occurs or if the specified arguments are invalid.

print

int print(int copies,
        java.util.List<GraphicsInfo> graphicsData)
          throws ConnectionException,
                 SettingsException,
                 ZebraCardException

Prints a card with the images provided.

Parameters:

copies - number of copies to be printed.

graphicsData - List containing details of the images to be printed.

Returns:

the assigned job ID number.

Throws:

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

SettingsException - if the job settings are not valid.

ZebraCardException - if a printer error occurs or if the specified arguments are invalid.

printTemplate

int printTemplate(int copies,
                TemplateJob jobData)
                  throws ConnectionException,
                         SettingsException,
                         ZebraCardException

Prints a card with the provided template.

Parameters:

copies - number of copies to be printed.

jobData - instance containing details of the job to be executed.

Returns:

the assigned job ID number.

Throws:

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

SettingsException - if the job settings are not valid.

ZebraCardException - if a printer error occurs or if the specified arguments are invalid.

printAndMagEncode

int printAndMagEncode(int copies,
                    java.util.List<GraphicsInfo> graphicsData,
                    String track1Data,
                    String track2Data,
                    String track3Data)
                      throws ConnectionException,
                             SettingsException,
                             ZebraCardException

Encodes the magnetic encoding data and prints a card with the images provided.

Parameters:

copies - number of copies to be printed.

graphicsData - List containing details of the images to be printed.

track1Data - data to be encoded on track 1.

track2Data - data to be encoded on track 2.

track3Data - data to be encoded on track 3.

Returns:

the assigned job ID number.

Throws:

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

SettingsException - if the job settings are not valid.

ZebraCardException - if a printer error occurs or if the specified arguments are invalid.

readMagData

MagTrackData readMagData(java.util.EnumSet<DataSource> tracksToRead)
                         throws ConnectionException,
                                SettingsException,
                                ZebraCardException,
                                java.util.concurrent.TimeoutException

Reads the data from a magnetically encoded card.

Parameters:

tracksToRead - specifies which tracks to read data from.

Returns:

instance containing the magnetic data read from the card.

Throws:

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

SettingsException - if the job settings are not valid.

java.util.concurrent.TimeoutException - if the process times out trying to read the data.

ZebraCardException - if a printer error occurs or tracksToRead is invalid.

readMagData

MagTrackData readMagData(java.util.EnumSet<DataSource> tracksToRead,
                       boolean isVerbose)
                         throws ConnectionException,
                                SettingsException,
                                java.util.concurrent.TimeoutException,
                                ZebraCardException

Reads the data from a magnetically encoded card.

Parameters:

tracksToRead - specifies which tracks to read data from.

isVerbose - true to increase the amount of detail presented to the user.

Returns:

instance containing the magnetic data read from the card.

Throws:

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

SettingsException - if the job settings are not valid.

java.util.concurrent.TimeoutException - if the process times out trying to read the data.

ZebraCardException - if a printer error occurs or tracksToRead is invalid.

reprint

void reprint(int copies)
             throws ConnectionException,
                    ZebraCardException

Reprints the last rendered job.

Parameters:

copies - number of copies to reprint.

Throws:

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

ZebraCardException - if a printer error occurs or copies is invalid.

resume

void resume()
            throws ZebraCardException,
                   ConnectionException

Resumes the processing of a held job such as a smart card encoding job.

Throws:

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

ZebraCardException - if a printer error occurs.

smartCardEncode

int smartCardEncode(int copies)
                    throws ConnectionException,
                           SettingsException,
                           ZebraCardException

Positions a card at the smartcard station, suspends the job to allow the card to be read or encoded, and waits for resume() to be called before completing the job.

• Smartcard job settings must be configured prior to calling this method in order to specify the card type.

Parameters:

copies - number of cards to be encoded.

Returns:

the assigned job ID number.

Throws:

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

SettingsException - if the job settings are not valid.

ZebraCardException - if a printer error occurs or copies is invalid.

destroy

void destroy()
             throws ZebraCardException

Clean up all the resources and stop any running threads.

• ZXP Series 1/3: calling destroy with pending or active jobs will result in all jobs being canceled. For best performance all jobs should be completed or canceled prior to calling this method.

Throws:

ZebraCardException - if the device is busy, a printer error, or there is an error communicating with the printer.

setGraphics

void setGraphics(ZebraGraphicsI zebraCardGraphics)

Sets the zebraCardGraphics object.

Parameters:

zebraCardGraphics - Instance of ZebraCardGraphics.