com.zebra.sdk.zxp.job

Interface JobControlHelperUtilZxp

public interface JobControlHelperUtilZxp

Interface for configuring job related parameters.

• JobControl settings are not persistent across jobs, therefore they must be set for each job.

Method Summary

Methods

Modifier and Type	Method and Description
CardDestination	getCardDestination() Returns the destination of the card following job completion.
CardSource	getCardSource() Returns the card source location.
EnumSet<DataSource>	getDataSource() Returns the data source for all magnetic read operations.
CoercivityType	getMagCoercivity() Returns the coercivity type for magnetic encoding.
MagEncodingType	getMagEncodingType() Returns the type of magnetic encoding the will be performed.
MonoConversionType	getMonochromeConversion(CardSide side) Returns the type of monochrome conversion to be performed for the designated side of a card.
PrintOptimizationMode	getPrintOptimizationMode() Returns the print optimization mode.
ParameterInfo	getRibbonPanelIntensity(CardSide side, RibbonPanelType panel) Returns the requested ribbon panels intensity values.
boolean	isDeleteAfter() Returns whether or not the printer will delete the current job after successfully completing.
boolean	isMagVerification() Returns whether or not the current job will verify the magnetic encoding.
void	setCardDestination(CardDestination destination) Sets the card destination location for the current job.
void	setCardSource(CardSource cardSource) Sets the card source location for the current job.
void	setDataSource(EnumSet<DataSource> dataSource) Sets the data source for the specified magnetic read operation for the current job.
void	setDeleteAfter(boolean deleteAfter) Sets whether to delete the current job after successfully completing.
void	setJobConfiguration(JobConfigInfo jobConfig) Sets print job settings for the current print job.
void	setMagCoercivity(CoercivityType coercivity) Sets the coercivity type for magnetic encoding.
void	setMagEncodingType(MagEncodingType type) Sets the type of magnetic encoding to perform.
void	setMagVerification(boolean enabled) Set whether to verify the magnetic encoding on the current job.
void	setMonochromeConversion(CardSide side, MonoConversionType type) Sets the monochrome conversion operation to perform for the specified card side.
void	setPrintOptimizationMode(PrintOptimizationMode printMode) Sets the print optimization mode.
void	setRibbonPanelIntensity(CardSide side, RibbonPanelType panel, int intensity) Sets the specified ribbon panel's intensity value.
void	setSmartCardConfiguration(List<SmartCardType> smartCardTypes) Configures smart card encoding for the current job.

Method Detail

getMonochromeConversion

MonoConversionType getMonochromeConversion(CardSide side)
                                           throws SettingsException

Returns the type of monochrome conversion to be performed for the designated side of a card.

Parameters:

side - side of card.

Returns:

the monochrome conversion type.

Throws:

SettingsException - if an error occurs while retrieving the monochrome conversion, the device is busy, a printer error occurs, or there is a communication error.

getRibbonPanelIntensity

ParameterInfo getRibbonPanelIntensity(CardSide side,
                                    RibbonPanelType panel)
                                      throws SettingsException

Returns the requested ribbon panels intensity values.

Parameters:

side - side of card.

panel - the specific ribbon panel to be used.

Returns:

instance containing the requested panels intensity values.

Throws:

SettingsException - if an error occurs while retrieving the ribbon panel intensity, the device is busy, or there is an error communicating with the printer.

setMonochromeConversion

void setMonochromeConversion(CardSide side,
                           MonoConversionType type)
                             throws SettingsException

Sets the monochrome conversion operation to perform for the specified card side.

• Default value is Diffusion.

Parameters:

side - side of card.

type - the monochrome conversion type.

Throws:

SettingsException - if an error occurs while setting the monochrome conversion type, the device is busy, a printer error occurs, or there is an error communicating with the printer.

setRibbonPanelIntensity

void setRibbonPanelIntensity(CardSide side,
                           RibbonPanelType panel,
                           int intensity)
                             throws SettingsException

Sets the specified ribbon panel's intensity value.

• Default value is '0' for both sides and all panel types.

Parameters:

side - side of card.

panel - the specific ribbon panel to be used.

intensity - intensity value.

Throws:

SettingsException - if an error occurs while setting the ribbon panel intensity, the device is busy, a printer error occurs, or there is an error communicating with the printer.

getCardDestination

CardDestination getCardDestination()
                                   throws SettingsException

Returns the destination of the card following job completion.

Returns:

the destination of the card.

Throws:

SettingsException - if an error occurs retrieving the card destination, the device is busy, a printer error occurs, or there is an error communicating with the printer.

getCardSource

CardSource getCardSource()
                         throws SettingsException

Returns the card source location.

Returns:

the card source location.

Throws:

SettingsException - if an error occurs retrieving the card source, the device is busy, a printer error occurs, or there is an error communicating with the printer.

getDataSource

EnumSet<DataSource> getDataSource()
                                  throws SettingsException

Returns the data source for all magnetic read operations.

Returns:

all magnetic read operations.

Throws:

SettingsException - if an error occurs retrieving the data source, the device is busy, a printer error occurs, or there is an error communicating with the printer.

getMagEncodingType

MagEncodingType getMagEncodingType()
                                   throws SettingsException

Returns the type of magnetic encoding the will be performed.

Returns:

the type of magnetic encoding.

Throws:

SettingsException - if an error occurs while retrieving the magnetic encoding type.

getMagCoercivity

CoercivityType getMagCoercivity()
                                throws SettingsException

Returns the coercivity type for magnetic encoding.

Returns:

the magnetic coercivity type.

Throws:

SettingsException - if an error occurs retrieving the magnetic coercivity.

isDeleteAfter

boolean isDeleteAfter()
                      throws SettingsException

Returns whether or not the printer will delete the current job after successfully completing.

Returns:

true if the printer deletes the job it is completed successfully.

Throws:

SettingsException - if an error occurs retrieving the delete after value, the device is busy, a printer error occurs, or there is an error communicating with the printer.

isMagVerification

boolean isMagVerification()
                          throws SettingsException

Returns whether or not the current job will verify the magnetic encoding.

Returns:

true if the current job will verify the magnetic encoding.

Throws:

SettingsException - if an error occurs retrieving the magnetic verification value.

setCardSource

void setCardSource(CardSource cardSource)
                   throws SettingsException

Sets the card source location for the current job.

Parameters:

cardSource - the card source location.

Throws:

SettingsException - if an error occurs while setting the card source, the device is busy, a printer error occurs, or there is an error communicating with the printer.

setCardDestination

void setCardDestination(CardDestination destination)
                        throws SettingsException

Sets the card destination location for the current job.

Parameters:

destination - the card destination location.

Throws:

SettingsException - if an error occurs while setting the card destination, the device is busy, a printer error occurs, or there is an error communicating with the printer.

setDataSource

void setDataSource(EnumSet<DataSource> dataSource)
                   throws SettingsException

Sets the data source for the specified magnetic read operation for the current job.

Parameters:

dataSource - EnumSet of DataSource objects.

Throws:

SettingsException - if an error occurs while setting the data source, the device is busy, a printer error occurs, or there is an error communicating with the printer.

setSmartCardConfiguration

void setSmartCardConfiguration(List<SmartCardType> smartCardTypes)
                               throws SettingsException,
                                      ZebraIllegalArgumentException

Configures smart card encoding for the current job.

Parameters:

smartCardTypes - list of smartcard types for configuring a smart card encoding job.

Throws:

SettingsException - if an error occurs while setting the smart card configuration.

ZebraIllegalArgumentException - if the smartCardTypes is invalid.

setDeleteAfter

void setDeleteAfter(boolean deleteAfter)
                    throws SettingsException

Sets whether to delete the current job after successfully completing.

Parameters:

deleteAfter - true to delete the current job after completing successfully.

Throws:

SettingsException - if an error occurs setting the delete after value, the device is busy, a printer error occurs, or there is an error communicating with the printer.

setJobConfiguration

void setJobConfiguration(JobConfigInfo jobConfig)
                         throws SettingsException

Sets print job settings for the current print job.

Parameters:

jobConfig - instance containing details of the job to be printed.

Throws:

SettingsException - if an error occurs while setting the job configuration, the device is busy, a printer error occurs, or there is an error communicating with the printer.

setMagCoercivity

void setMagCoercivity(CoercivityType coercivity)
                      throws SettingsException

Sets the coercivity type for magnetic encoding.

Parameters:

coercivity - the magnetic coercivity type.

Throws:

SettingsException - if an error occurs while setting the magnetic coercivity.

setMagEncodingType

void setMagEncodingType(MagEncodingType type)
                        throws SettingsException

Sets the type of magnetic encoding to perform.

Parameters:

type - the magnetic encoding type.

Throws:

SettingsException - if an error occurs while retrieving the magnetic encoding type.

setMagVerification

void setMagVerification(boolean enabled)
                        throws SettingsException

Set whether to verify the magnetic encoding on the current job.

Parameters:

enabled - true to verify the magnetic encoding.

Throws:

SettingsException - if an error occurs while setting the magnetic verification value.

setPrintOptimizationMode

void setPrintOptimizationMode(PrintOptimizationMode printMode)
                              throws SettingsException

Sets the print optimization mode.

• For ZXP3xC printer models only

Parameters:

printMode - the print optimization mode for ZXP3xC printer models.

Throws:

SettingsException - if an error occurs while setting the print optimization mode, the device is busy, a printer error, or there is an error communicating with the printer.

getPrintOptimizationMode

PrintOptimizationMode getPrintOptimizationMode()
                                               throws SettingsException

Returns the print optimization mode.

• For ZXP3xC printer models only

Returns:

the print optimization mode for ZXP3xC printer models.

Throws:

SettingsException - if an error occurs while retrieving the print optimization mode.