com.zebra.sdk.zxp.settings

Interface SettingsHelperUtilZxp

public interface SettingsHelperUtilZxp

Provides device settings convenience methods for ZXP Series printers.

Method Summary

Methods

Modifier and Type	Method and Description
ATMMode	getATMMode() Returns the ATM card feed mode.
ParameterInfo	getEndCardOffset() Returns the printer's end of print value.
ParameterInfo	getHeadResistance() Returns the print head resistance value and valid range.
MagneticEncoderOffsetInfo	getMagneticEncoderOffsets() Returns the magnetic encoder offset values.
ParameterInfo	getMonochromeBias() Returns the monochrome bias value.
NetworkInfo	getNetworkParameters() Returns a printer's current network parameters.
ParameterInfo	getXOffset(CardSide side) Returns the x-offset for the specified card side.
ParameterInfo	getYOffset(CardSide side) Returns the y-offset for the specified card side.
boolean	isCardPrefeed() Returns the card pre-feed enabled state.
void	setATMMode(ATMMode mode) Sets the ATM card feed mode.
void	setCardPrefeed(boolean enable) Sets the card pre-feed enabled state.
void	setEndCardOffset(int offset) Sets the printer's end of print value.
void	setMonochromeBias(int bias) Sets the monochrome bias value.
void	setXOffset(CardSide side, int offset) Sets the X offset for the specified side of the card.
void	setYOffset(CardSide side, int offset) Sets the y-offset for the specified card side.

Method Detail

getATMMode

ATMMode getATMMode()
                   throws ConnectionException,
                          SettingsException

Returns the ATM card feed mode.

Returns:

the card feeder source.

Throws:

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

SettingsException - if an error occurs while retrieving the ATM card feed mode.

getEndCardOffset

ParameterInfo getEndCardOffset()
                               throws ConnectionException,
                                      SettingsException

Returns the printer's end of print value.

Returns:

instance containing the ec-offset value and range limits.

Throws:

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

SettingsException - if an error occurs while retrieving the end car offset.

getMonochromeBias

ParameterInfo getMonochromeBias()
                                throws ConnectionException,
                                       SettingsException

Returns the monochrome bias value.

Returns:

instance containing the monochrome bias value and range limits.

Throws:

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

SettingsException - if an error occurs while retrieving the monochrome bias value.

getXOffset

ParameterInfo getXOffset(CardSide side)
                         throws ConnectionException,
                                SettingsException

Returns the x-offset for the specified card side.

Parameters:

side - side of card.

Returns:

instance containing the x-offset value and range limits.

Throws:

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

SettingsException - if an error occurs while retrieving the x-offset.

getYOffset

ParameterInfo getYOffset(CardSide side)
                         throws ConnectionException,
                                SettingsException

Returns the y-offset for the specified card side.

Parameters:

side - side of card.

Returns:

instance containing the y-offset value and range limits.

Throws:

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

SettingsException - if an error occurs while retrieving the y-offset.

isCardPrefeed

boolean isCardPrefeed()
                      throws ConnectionException,
                             SettingsException

Returns the card pre-feed enabled state.

Returns:

true if the pre-feed state is enabled.

Throws:

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

SettingsException - if an error occurs while retrieving the card pre-feed state.

setATMMode

void setATMMode(ATMMode mode)
                throws SettingsException

Sets the ATM card feed mode.

Parameters:

mode - the card feeder source.

Throws:

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

setCardPrefeed

void setCardPrefeed(boolean enable)
                    throws SettingsException

Sets the card pre-feed enabled state.

Parameters:

enable - true to enable.

Throws:

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

setEndCardOffset

void setEndCardOffset(int offset)
                      throws SettingsException

Sets the printer's end of print value.

Parameters:

offset - end of print offset value.

Throws:

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

setMonochromeBias

void setMonochromeBias(int bias)
                       throws SettingsException

Sets the monochrome bias value.

Parameters:

bias - the offset value to be applied to monochrome printing.

Throws:

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

setXOffset

void setXOffset(CardSide side,
              int offset)
                throws SettingsException

Sets the X offset for the specified side of the card.

Parameters:

side - side of card.

offset - the y-offset value for the specified card side.

Throws:

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

setYOffset

void setYOffset(CardSide side,
              int offset)
                throws SettingsException

Sets the y-offset for the specified card side.

Parameters:

side - side of card.

offset - the y-offset value for the specified card side.

Throws:

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

getNetworkParameters

NetworkInfo getNetworkParameters()
                                 throws SettingsException

Returns a printer's current network parameters.

Returns:

the printer's wired network configuration.

Throws:

SettingsException - if an error occurs while retrieving the network parameters, the device is busy, a printer error, or there is an error communicating with the printer.

getHeadResistance

ParameterInfo getHeadResistance()
                                throws ConnectionException,
                                       SettingsException

Returns the print head resistance value and valid range.

Returns:

information about the print head resistance 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.

getMagneticEncoderOffsets

MagneticEncoderOffsetInfo getMagneticEncoderOffsets()
                                                    throws ConnectionException,
                                                           SettingsException,
                                                           ZebraCardException

Returns the magnetic encoder offset values.

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 a printer error occurs.