com.zebra.sdk.zmotif.settings

Interface SettingsHelperUtilZmotif

public interface SettingsHelperUtilZmotif

Provides device settings convenience methods for ZMotif Series printers.

Method Summary

Methods

Modifier and Type	Method and Description
CalibrationTable	getActiveLUTTable() Get the printer's Active LUT Table. ZMotif series 7, 8, and 9 printers only.
String	getCalibrationTableData(CalibrationTable table) Get the printer's specified Calibration Table data. ZMotif series 7, 8, and 9 printers only.
java.util.Map<CalibrationTable,String>	getCalibrationTableNames() Get the list of all the stored calibration tables from the printer. ZMotif series 7, 8, and 9 printers only.
String	getCapabilities(CapabilitiesType reportType) Get the printer's specified Capabilities in an XML format.
ParameterInfo	getCleaningInterval(CleaningPath path) Get specified Cleaning Path ParameterInfo object
ParameterInfo	getCleanWarningThreshold() Get the printer's Cleaning Warning Threshold.
String	getConfiguration() Get the XML configuration.
ParameterInfo	getContactlessSmartCardOffset(String encoderType) Returns the offset value for the specified contactless smart card encoder type.
CardTypeInfo	getCustomCardConfiguration(CustomCard card) Get the specified Card Type Information.
ErrorControlLevel	getErrorControlLevel() Get the Error Control Level.
ParameterInfo	getHeadResistance() Returns the ParameterInfo object.
TransferType	getImageTransferType() Get the printer's Image Transfer Type.
ParameterInfo	getLaminatorOffset(LaminatorOffsetType type) Get the printer's laminator offset value and range.
MagneticEncoderOffsetInfo	getMagneticEncoderOffsets() Gets the Magnetic Encoder Offset Info object
NetworkInfo	getNetworkParameters() Gets the NetworkInfo object
OCPSettings	getOCPParameters() Gets the printer's OCP configuration. ZMotif series 7, 8, and 9 printers only.
ParameterInfo	getPanelPowerLevel(PanelType panel) Gets the specified panel Power Level.
ParameterInfo	getSmartCardOffset() Gets the Smart Card Offset ParameterInfo object.
Timeout	getStandbyTimeout() Get the printer's Standby Timeout.
ParameterInfo	getTransferTemperatureOffset(TransferTemperatureType type) Get the transfer temperature offset for the specified transfer sensor. For ZMotif Series re-transfer printers only.
WirelessNetworkInfo	getWirelessParameters() Gets the Wireless Network Information.
void	loadCalibrationTableData(String xmlCalibrationData) Load the Calibration table data from an XML Calibration Data document. ZMotif series 7, 8, and 9 printers only.
void	setActiveLUTTable(CalibrationTable table) Set the printer's Active LUT Table. ZMotif series 7, 8, and 9 printers only.
void	setCleaningInterval(CleaningPath path, int interval) Sets the specified Cleaning path interval.
void	setCleanWarningThreshold(int threshold) Set the printer's Cleaning Warning Threshold.
void	setConfiguration(String xmlConfiguration) Set specified values for settings with an XML form.
void	setContactlessSmartCardOffset(String encoderType, int offset) Sets the contactless smart card encoding position offset value.
void	setCustomCardConfiguration(CardTypeInfo cardInfo) Set the specified Card Type Information.
void	setErrorControlLevel(ErrorControlLevel level) Set the Error Control Level.
void	setHeadResistance(int headResistance) Sets the Head Resistance
void	setLaminatorOffset(LaminatorOffsetType type, int value) Set the printer's laminator offset value.
void	setMagneticEncoderOffsets(MagneticEncoderOffsetInfo offsets) Set Magnetic Encoder Offsets.
void	setNetworkParameters(NetworkInfo netInfo) Set the printer's Network Information.
void	setOCPParameters(OCPSettings ocpParams) Set the printer's OCP configuration. ZMotif series 7, 8, and 9 printers only.
void	setPanelPowerLevel(PanelType panel, byte powerLevel) Set specified Panel power level
void	setSmartCardOffset(int offset) Sets the contact smart card encoding position offset value.
void	setStandbyTimeout(Timeout timeout) Set the printer's Standby Timeout.
void	setTransferTemperatureOffset(TransferTemperatureType type, int offset) Set the transfer temperature offset for the specified transfer sensor. For ZMotif Series re-transfer printers only.
void	setWirelessParameters(WirelessNetworkInfo netInfo) Sets the Wireless Network Information.

Method Detail

getHeadResistance

ParameterInfo getHeadResistance()
                                throws ConnectionException,
                                       SettingsException

Returns the ParameterInfo object.

Returns:

Container holding information about a settings value and range.

Throws:

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

SettingsException - if an error occurs while retrieving the head resistance.

setHeadResistance

void setHeadResistance(int headResistance)
                       throws SettingsException

Sets the Head Resistance

Parameters:

headResistance - value to set the head resistance to.

Throws:

SettingsException - if the device is busy, there is an error communicating with the printer., a printer error occurs, or the headResistance is invalid.

getNetworkParameters

NetworkInfo getNetworkParameters()
                                 throws SettingsException

Gets the NetworkInfo object

Returns:

the printer's wired network configuration.

Throws:

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

getCleaningInterval

ParameterInfo getCleaningInterval(CleaningPath path)
                                  throws ConnectionException,
                                         SettingsException

Get specified Cleaning Path ParameterInfo object

Parameters:

path - the cleaning path.

Returns:

the information about a settings value and range.

Throws:

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

SettingsException - if an error occurs while retrieving the cleaning interval.

setCleaningInterval

void setCleaningInterval(CleaningPath path,
                       int interval)
                         throws SettingsException

Sets the specified Cleaning path interval.

Parameters:

path - the path to be cleaned.

interval - the number of cards printed before the clean path warning appears.

Throws:

SettingsException - if the path or interval are invalid.

getSmartCardOffset

ParameterInfo getSmartCardOffset()
                                 throws ConnectionException,
                                        SettingsException

Gets the Smart Card Offset ParameterInfo object.

Returns:

information about a settings value and range.

Throws:

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

SettingsException - if an error occurs while retrieving the smart card offset.

setSmartCardOffset

void setSmartCardOffset(int offset)
                        throws SettingsException

Sets the contact smart card encoding position offset value.

Parameters:

offset - the contact smart card encoding position offset.

Throws:

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

setContactlessSmartCardOffset

void setContactlessSmartCardOffset(String encoderType,
                                 int offset)
                                   throws ConnectionException,
                                          SettingsException

Sets the contactless smart card encoding position offset value.

Parameters:

encoderType - The contactless encoding type.

offset - The contactless smart card encoding position offset.

Throws:

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

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

getContactlessSmartCardOffset

ParameterInfo getContactlessSmartCardOffset(String encoderType)
                                            throws ConnectionException,
                                                   SettingsException

Returns the offset value for the specified contactless smart card encoder type.

Parameters:

encoderType - The contactless encoder type. (mifare,uhf,hf,lf,other)

Returns:

The contactless smart card offset value and range.

Throws:

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

SettingsException - If the encoder type is not valid or an error occurs while retrieving the smart card offset.

getMagneticEncoderOffsets

MagneticEncoderOffsetInfo getMagneticEncoderOffsets()
                                                    throws ConnectionException,
                                                           SettingsException,
                                                           ZebraCardException

Gets the Magnetic Encoder Offset Info object

Returns:

the magnetic encoder offset values.

Throws:

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

SettingsException - if an error occurs while retrieving the magnetic encoder offsets.

ZebraCardException - if the printer does not have a magnetic encoder.

setMagneticEncoderOffsets

void setMagneticEncoderOffsets(MagneticEncoderOffsetInfo offsets)
                               throws SettingsException,
                                      ConnectionException,
                                      ZebraCardException

Set Magnetic Encoder Offsets.

Parameters:

offsets - the magnetic encoder offset values.

Throws:

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

SettingsException - if an error occurs setting the magnetic encoder offsets.

ZebraCardException - if the offsets map is invalid or an error occurs while setting the encoder offsets.

getConfiguration

String getConfiguration()
                        throws ConnectionException,
                               ZebraCardException

Get the XML configuration.

Returns:

printer configuration in XML form.

Throws:

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

ZebraCardException - if an error occurs while retrieving the configuration.

setConfiguration

void setConfiguration(String xmlConfiguration)
                      throws ConnectionException,
                             SettingsException,
                             ZebraCardException

Set specified values for settings with an XML form.

Parameters:

xmlConfiguration - the configuration to be sent to the printer.

Throws:

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

SettingsException - if an error occurs while setting the XML configuration.

ZebraCardException - if the xmlConfiguration is invalid or an error occurs while setting the configuration.

getWirelessParameters

WirelessNetworkInfo getWirelessParameters()
                                          throws SettingsException

Gets the Wireless Network Information.

Returns:

information about the printer's wireless network configuration.

Throws:

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

setWirelessParameters

void setWirelessParameters(WirelessNetworkInfo netInfo)
                           throws SettingsException,
                                  ZebraCardException

Sets the Wireless Network Information.

Parameters:

netInfo - information about the printer's wireless network configuration.

Throws:

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

ZebraCardException - if the netInfo is invalid.

getPanelPowerLevel

ParameterInfo getPanelPowerLevel(PanelType panel)
                                 throws ConnectionException,
                                        SettingsException

Gets the specified panel Power Level.

Parameters:

panel - the specific panel on the card ribbon.

Returns:

information about the panel's power level value and range.

Throws:

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

SettingsException - if the panel is invalid or an error occurs while retrieving the panel power level.

setPanelPowerLevel

void setPanelPowerLevel(PanelType panel,
                      byte powerLevel)
                        throws SettingsException

Set specified Panel power level

Parameters:

panel - the specific panel on the card ribbon.

powerLevel - the panel's power level.

Throws:

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

getOCPParameters

OCPSettings getOCPParameters()
                             throws ConnectionException,
                                    SettingsException

Gets the printer's OCP configuration.
ZMotif series 7, 8, and 9 printers only.

Returns:

the printer's OCP configuration.

Throws:

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

SettingsException - if the printer model is not supported or if an error occurs while retrieving the OCP configuration.

setOCPParameters

void setOCPParameters(OCPSettings ocpParams)
                      throws SettingsException,
                             ZebraCardException

Set the printer's OCP configuration.
ZMotif series 7, 8, and 9 printers only.

Parameters:

ocpParams - the printer's OCP configuration.

Throws:

SettingsException - if the printer model is not supported, the device is busy, or there is an error communicating with the printer.

ZebraCardException - if the ocpParams object is invalid.

getTransferTemperatureOffset

ParameterInfo getTransferTemperatureOffset(TransferTemperatureType type)
                                           throws ConnectionException,
                                                  SettingsException

Get the transfer temperature offset for the specified transfer sensor.
For ZMotif Series re-transfer printers only.

Parameters:

type - re-transfer Temperature sensor.

Returns:

information about the re-transfer temperature sensor value and range.

Throws:

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

SettingsException - if the type is invalid or an error occurs while retrieving the transfer temperature type.

setTransferTemperatureOffset

void setTransferTemperatureOffset(TransferTemperatureType type,
                                int offset)
                                  throws SettingsException

Set the transfer temperature offset for the specified transfer sensor.
For ZMotif Series re-transfer printers only.

Parameters:

type - re-transfer Temperature sensor.

offset - temperature value to set the sensor to.

Throws:

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

getCustomCardConfiguration

CardTypeInfo getCustomCardConfiguration(CustomCard card)
                                        throws SettingsException

Get the specified Card Type Information.

Parameters:

card - the custom card type to use.

Returns:

information about a specified card type.

Throws:

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

setCustomCardConfiguration

void setCustomCardConfiguration(CardTypeInfo cardInfo)
                                throws SettingsException,
                                       ZebraCardException

Set the specified Card Type Information.

Parameters:

cardInfo - information about a specified card type.

Throws:

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

ZebraCardException - if the cardInfo is invalid.

getErrorControlLevel

ErrorControlLevel getErrorControlLevel()
                                       throws ConnectionException,
                                              SettingsException

Get the Error Control Level.

Returns:

the printer's error control level.

Throws:

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

SettingsException - if an error occurs while retrieving the error control level.

setErrorControlLevel

void setErrorControlLevel(ErrorControlLevel level)
                          throws SettingsException

Set the Error Control Level.

Parameters:

level - the printer's error control level

Throws:

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

getStandbyTimeout

Timeout getStandbyTimeout()
                          throws ConnectionException,
                                 SettingsException

Get the printer's Standby Timeout.

Returns:

the amount of time before the printer enters standby mode.

Throws:

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

SettingsException - if an error occurs while retrieving the standby timeout.

getCapabilities

String getCapabilities(CapabilitiesType reportType)
                       throws ConnectionException,
                              ZebraCardException

Get the printer's specified Capabilities in an XML format.

Parameters:

reportType - the type of printer capabilities to request.

Returns:

the printer's specified Capabilities in an XML format.

Throws:

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

ZebraCardException - if an error occurs while retrieving the capabilities.

setStandbyTimeout

void setStandbyTimeout(Timeout timeout)
                       throws SettingsException

Set the printer's Standby Timeout.

Parameters:

timeout - the amount of time before the printer enters standby mode.

Throws:

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

setCleanWarningThreshold

void setCleanWarningThreshold(int threshold)
                              throws SettingsException

Set the printer's Cleaning Warning Threshold.

Parameters:

threshold - the amount of cards printed before the Cleaning Warning appears on the printer.

Throws:

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

getCleanWarningThreshold

ParameterInfo getCleanWarningThreshold()
                                       throws ConnectionException,
                                              SettingsException

Get the printer's Cleaning Warning Threshold.

Returns:

the amount of cards printed before the Cleaning Warning appears on the printer and the Cleaning Warning Threshold range.

Throws:

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

SettingsException - if an error occurs while retrieving the cleaning warning threshold.

setActiveLUTTable

void setActiveLUTTable(CalibrationTable table)
                       throws SettingsException

Set the printer's Active LUT Table.
ZMotif series 7, 8, and 9 printers only.

Parameters:

table - a specific Calibration Table contained in the printer.

Throws:

SettingsException - if the printer model is not supported, the device is busy, or there is an error communicating with the printer.

getActiveLUTTable

CalibrationTable getActiveLUTTable()
                                   throws ConnectionException,
                                          SettingsException

Get the printer's Active LUT Table.
ZMotif series 7, 8, and 9 printers only.

Returns:

a specific Calibration Table contained in the printer.

Throws:

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

SettingsException - if the printer model is not supported, if an error occurs while retrieving the active LUT table.

loadCalibrationTableData

void loadCalibrationTableData(String xmlCalibrationData)
                              throws ConnectionException,
                                     ZebraCardException

Load the Calibration table data from an XML Calibration Data document.
ZMotif series 7, 8, and 9 printers only.

Parameters:

xmlCalibrationData - the Calibration Data in an XML document.

Throws:

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

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

setNetworkParameters

void setNetworkParameters(NetworkInfo netInfo)
                          throws SettingsException,
                                 ZebraCardException

Set the printer's Network Information.

Parameters:

netInfo - the printer's wired network configuration.

Throws:

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

ZebraCardException - if the netInfo is invalid.

getCalibrationTableData

String getCalibrationTableData(CalibrationTable table)
                               throws ConnectionException,
                                      ZebraCardException

Get the printer's specified Calibration Table data.
ZMotif series 7, 8, and 9 printers only.

Parameters:

table - a specific Calibration Table contained in the printer.

Returns:

calibration data table The Calibration Table data for the specified Calibration data.

Throws:

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

ZebraCardException - if the printer model is not supported or if an error occurs while retrieving the calibration table.

getCalibrationTableNames

java.util.Map<CalibrationTable,String> getCalibrationTableNames()
                                                                throws ConnectionException,
                                                                       SettingsException

Get the list of all the stored calibration tables from the printer.
ZMotif series 7, 8, and 9 printers only.

Returns:

Map of Calibration tables

• Key = a specific Calibration Table contained in the printer.
• Value = The Calibration Table data for the specified Calibration data.

Throws:

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

SettingsException - if the printer model is not supported, or an error occurs while retrieving the calibration table names.

getImageTransferType

TransferType getImageTransferType()
                                  throws ConnectionException,
                                         SettingsException

Get the printer's Image Transfer Type.

Returns:

the transfer type of the printer.

Throws:

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

SettingsException - if an error occurs while retrieving the image transfer type.

getLaminatorOffset

ParameterInfo getLaminatorOffset(LaminatorOffsetType type)
                                 throws ConnectionException,
                                        SettingsException

Get the printer's laminator offset value and range.

Parameters:

type - the laminator offset type to get.

Returns:

information about the printer's laminator offset value and range.

Throws:

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

SettingsException - if the type is invalid or an error occurs while retrieving the laminator offset.

setLaminatorOffset

void setLaminatorOffset(LaminatorOffsetType type,
                      int value)
                        throws SettingsException

Set the printer's laminator offset value.

Parameters:

type - the laminator offset type to set.

value - the laminator offset value.

Throws:

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