Package de.gmxhome.conrad.jpos.jpos_base.micr

Interface MICRInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

MICR, MICRProperties

public interface MICRInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the MICR device category. For details about properties, methods and method parameters, see UPOS specification, chapter MICR - Magnetic Ink Character Recognition Reader. Further details about error handling can be found in introduction - Device Behavior Models - Errors.

Method Summary

Modifier and Type	Method	Description
void	beginInsertion(int timeout)	Final part of BeginInsertion method.
void	beginRemoval(int timeout)	Final part of BeginRemoval method.
void	checkBusy()	Checks whether the device is busy.
void	checkNoData()	Checks whether MICR data are available for processing.
void	endInsertion()	Final part of EndInsertion method.
void	endRemoval()	Final part of EndRemoval method.

Methods inherited from interface de.gmxhome.conrad.jpos.jpos_base.JposBaseInterface

asyncMode, autoDisable, checkHealth, claim, clearInput, clearOutput, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, handlePowerStateOnEnable, newJposOutputRequest, open, powerNotify, release, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, unitDataCount, updateFirmware, updateFirmware, updateStatistics

Method Details

checkNoData

void checkNoData()
          throws jpos.JposException

Checks whether MICR data are available for processing. The default implementation returns if CheckType > 0. Otherwise, a UPOS exception will be generated with error code E_EXTENDED and extender error code EMICR_NODATA. The following checks have been made before this method will be invoked:

• The device has been claimed.

Throws:

jpos.JposException - If MICR data cannot be retrieved.

checkBusy

void checkBusy()
        throws jpos.JposException

Checks whether the device is busy. Since MICRService often shares one physical device with a printer, busy means MICR or printer of the device is busy. If checking property State is not enough, this method must be overwritten in a derived class.

Throws:

jpos.JposException - If device is busy orin error status.

beginInsertion

void beginInsertion(int timeout)
             throws jpos.JposException

Final part of BeginInsertion method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• checkBusy did not throw an exception,
• The timeout is ≥ 0 or JPOS_FOREVER.

If the service enters insertion mode successfully after BeginInsertion failed, e.g. due to a timeout condition during delayed asynchronous insertion handling, property InsertionMode must be set to true by the specific service implementation to avoid EndInsertion to fail.

Parameters:

timeout - See UPOS specification, method BeginInsertion.

Throws:

jpos.JposException - See UPOS specification, method DisplayText.

beginRemoval

void beginRemoval(int timeout)
           throws jpos.JposException

Final part of BeginRemoval method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• checkBusy did not throw an exception,
• The timeout is ≥ 0 or JPOS_FOREVER.

If the service enters removal mode successfully after BeginRemoval failed, e.g. due to a timeout condition during delayed asynchronous removal handling, property RemovalMode must be set to true by the specific service implementation to avoid EndRemoval to fail.

Parameters:

timeout - See UPOS specification, method BeginRemoval.

Throws:

jpos.JposException - See UPOS specification, method DisplayText.

endInsertion

void endInsertion()
           throws jpos.JposException

Final part of EndInsertion method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• checkBusy did not throw an exception,
• Device is not in insertion mode,

Throws:

jpos.JposException - See UPOS specification, method EndInsertion.

endRemoval

void endRemoval()
         throws jpos.JposException

Final part of EndRemoval method. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• checkBusy did not throw an exception,
• Device is not in removal mode,

Throws:

jpos.JposException - See UPOS specification, method EndRemoval.