com.zebra.sdk.zmotif.device

Interface DeviceUtilZmotif

All Known Subinterfaces:

ZebraPrinterZmotif

public interface DeviceUtilZmotif

Interface to ZMotif printer utility functions

Method Summary

Methods

Modifier and Type	Method and Description
AlarmInfo	clearError() Clears the printer error and returns the printer alarm information.
void	clearRejectBinCounter() Clears the printer's Reject Bin counter.
java.util.List<String>	getAvailableCardTypes() Queries the printer and returns the available card types.
MemoryInfo	getAvailableMemory() Queries the printer and returns the memory available for job storage.
CardTypeInfo	getCardTypeInformation(String cardType) Queries the printer and returns the card type information for specified card type.
String	getLog(LogType logType, boolean clearLog) Queries the printer and returns the specified log.
java.util.Map<String,String>	getWirelessRadioStatus() Queries the printer and returns the Wireless Radio Status.
java.util.Map<String,String>	getWirelessStatus() Queries the printer and returns the Wireless Status.
boolean	hasBarcodeReader() Queries the printer's configuration and returns true if printer includes barcode reader.
boolean	isEncryptionEnabled() Returns whether encryption is enabled on the printer.
boolean	isHostAuthenticationEnabled() Returns whether host authentication mode is enabled.
void	resetNetwork() Sends the network reset command to the printer.
void	resumeFromStandby() Resume from standby.
java.util.List<WirelessAccessPointInfo>	scanWirelessAccessPoints(int scanIterations) Gets the Access points discoverable by printer.

Method Detail

clearError

AlarmInfo clearError()
                     throws ConnectionException,
                            ZebraCardException

Clears the printer error and returns the printer alarm information.

Returns:

the alarm information.

• refer to ZebraCardErrors for list of error codes and descriptions

Throws:

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

ZebraCardException - if a printer error occurs.

clearRejectBinCounter

void clearRejectBinCounter()
                           throws ConnectionException,
                                  SettingsException,
                                  ZebraCardException

Clears the printer's Reject Bin counter.

Throws:

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

SettingsException - if there is an issue clearing the reject bin count.

ZebraCardException - if a printer error occurs.

getAvailableCardTypes

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

Queries the printer and returns the available card types.

Returns:

list of Card Types.

Throws:

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

SettingsException - if there is an error retrieving the available card types.

ZebraCardException - if a printer error occurs.

getAvailableMemory

MemoryInfo getAvailableMemory()
                              throws ConnectionException,
                                     SettingsException,
                                     ZebraCardException

Queries the printer and returns the memory available for job storage.

Returns:

the printer's available memory.

Throws:

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

SettingsException - if there is an error retrieving the available memory.

ZebraCardException - if a printer error occurs.

getCardTypeInformation

CardTypeInfo getCardTypeInformation(String cardType)
                                    throws ConnectionException,
                                           SettingsException,
                                           ZebraCardException,
                                           ZebraIllegalArgumentException

Queries the printer and returns the card type information for specified card type.

Parameters:

cardType - - type of card.

Returns:

information about a specified card type.

Throws:

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

SettingsException - if there is an error retrieving the card type information.

ZebraCardException - if a printer error occurs.

ZebraIllegalArgumentException - if the cardType specified is invalid.

getLog

String getLog(LogType logType,
            boolean clearLog)
              throws ConnectionException,
                     ZebraCardException

Queries the printer and returns the specified log.

Parameters:

logType - the type of log.

clearLog - true to clear the log or not.

Returns:

the log in XML form.

Throws:

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

ZebraCardException - if a printer error occurs.

getWirelessRadioStatus

java.util.Map<String,String> getWirelessRadioStatus()
                                                    throws ConnectionException,
                                                           SettingsException,
                                                           ZebraCardException

Queries the printer and returns the Wireless Radio Status.

Returns:

map of Wireless Radio Status.

• Key = Wireless Radio Setting
• Value = Setting value

Throws:

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

SettingsException - if an error occurs while retrieving the wireless radio status.

ZebraCardException - if a printer error occurs.

getWirelessStatus

java.util.Map<String,String> getWirelessStatus()
                                               throws ConnectionException,
                                                      SettingsException,
                                                      ZebraCardException

Queries the printer and returns the Wireless Status.

Returns:

map of Wireless Status.

• Key = Wireless Setting
• Value = Setting value

Throws:

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

SettingsException - if an error occurs while retrieving the wireless status.

ZebraCardException - if a printer error occurs.

resumeFromStandby

void resumeFromStandby()
                       throws ConnectionException,
                              ZebraCardException

Resume from standby.

Throws:

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

ZebraCardException - if a printer error occurs.

scanWirelessAccessPoints

java.util.List<WirelessAccessPointInfo> scanWirelessAccessPoints(int scanIterations)
                                                                 throws ConnectionException,
                                                                        SettingsException,
                                                                        ZebraCardException

Gets the Access points discoverable by printer.

Parameters:

scanIterations - number of scan iterations.

Returns:

list of WirelessAccessPointInfo.

Throws:

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

SettingsException - if an error occurs while retrieving the available access points.

ZebraCardException - if a printer error occurs.

hasBarcodeReader

boolean hasBarcodeReader()
                         throws ConnectionException,
                                SettingsException,
                                ZebraCardException

Queries the printer's configuration and returns true if printer includes barcode reader.

Returns:

true if printer configuration includes a barcode reader.

Throws:

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

SettingsException - if an error occurs while retrieving the barcode reader information.

ZebraCardException - if a printer error occurs.

isHostAuthenticationEnabled

boolean isHostAuthenticationEnabled()
                                    throws ConnectionException

Returns whether host authentication mode is enabled.

Returns:

true if host authentication is enabled.

Throws:

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

isEncryptionEnabled

boolean isEncryptionEnabled()
                            throws ConnectionException

Returns whether encryption is enabled on the printer.

Returns:

true if encryption is enabled.

Throws:

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

resetNetwork

void resetNetwork()
                  throws ConnectionException,
                         SettingsException,
                         ZebraCardException

Sends the network reset command to the printer.

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

SettingsException