Package de.gmxhome.conrad.jpos.jpos_base.checkscanner

Interface CheckScannerInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

CheckScannerProperties

public interface CheckScannerInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the CheckScanner device category. For details about properties, methods and method parameters, see UPOS specification, chapter Check Scanner. 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	checkMandatoryProperties()	Checks whether mandatory properties can be set to plausible values due to specific capability values.
void	clearImage(int by)	Final part of ClearImage method.
void	color(int color)	Final part of setting Color.
void	concurrentMICR(boolean concurrentMICR)	Final part of setting ConcurrentMICR.
void	contrast(int contrast)	Final part of setting Contrast.
void	defineCropArea(int cropAreaID, int x, int y, int cx, int cy)	Final part of DefineCropArea method.
void	documentHeight(int documentHeight)	Final part of setting DocumentHeight.
void	documentWidth(int documentWidth)	Final part of setting DocumentWidth.
void	endInsertion()	Final part of EndInsertion method.
void	endRemoval()	Final part of EndRemoval method.
void	fileID(String fileID)	Final part of setting FileID.
void	fileIndex(int fileIndex)	Final part of setting FileIndex.
void	imageFormat(int imageFormat)	Final part of setting ImageFormat.
void	imageTagData(String imageTagData)	Final part of setting ImageTagData.
void	mapMode(int mapMode)	Final part of setting MapMode.
void	quality(int quality)	Final part of setting Quality.
void	retrieveImage(int cropAreaID)	Final part of RetrieveImage method.
void	retrieveMemory(int by)	Final part of RetrieveMemory method.
void	storeImage(int cropAreaID)	Final part of StoreImage 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

checkMandatoryProperties

void checkMandatoryProperties()
                       throws jpos.JposException

Checks whether mandatory properties can be set to plausible values due to specific capability values. If so, these properties will be set to the corresponding values. Otherwise, these properties must be initialized either in the Device's changeDefaults or checkProperties method.
A call of this method in a CheckScanner device factory after the call of the Device's checkProperties method is mandatory.

Throws:

jpos.JposException - If one of the mandatory properties has not been set previously.

color

void color(int color)
    throws jpos.JposException

Final part of setting Color. 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 open,
• color is one of CL_MONO, CL_GRAYSCALE, CL_16, CL_256 or CL_FULL,
• the corresponding bit in CapColor (CCL_MONO, ...) is set.

Parameters:

color - New value for Color property.

Throws:

jpos.JposException - If an error occurs.

concurrentMICR

void concurrentMICR(boolean concurrentMICR)
             throws jpos.JposException

Final part of setting ConcurrentMICR. 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 open,
• CapMICRDevice is false or CapConcurrentMICR is true or concurrentMICR is false,
• internal property AllowAlwaysSetProperties is true or concurrentMICR equals the previous value of ConcurrentMICR.

Parameters:

concurrentMICR - New value for ConcurrentMICR property.

Throws:

jpos.JposException - If an error occurs.

contrast

void contrast(int contrast)
       throws jpos.JposException

Final part of setting Contrast. 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,
• 0 ≤ contrast %le; 100 or contrast = AUTOMATIC_CONTRAST and CapAutoContrast = true.

Parameters:

contrast - New value for Contrast property.

Throws:

jpos.JposException - If an error occurs.

documentHeight

void documentHeight(int documentHeight)
             throws jpos.JposException

Final part of setting DocumentHeight. 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 open,
• documentHeight is not negative,
• documentHeight in combination with MapMode does not specify a height above the initial DocumentHeight value,
• internal property AllowAlwaysSetProperties is true or documentHeight equals the previous value of DocumentHeight.

Parameters:

documentHeight - New value for DocumentHeight property.

Throws:

jpos.JposException - If an error occurs.

documentWidth

void documentWidth(int documentWidth)
            throws jpos.JposException

Final part of setting DocumentWidth. 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 open,
• documentWidth is not negative,
• documentWidth in combination with MapMode does not specify a width above the initial DocumentWidth value,
• internal property AllowAlwaysSetProperties is true or documentWidth equals the previous value of DocumentWidth.

Parameters:

documentWidth - New value for DocumentWidth property.

Throws:

jpos.JposException - If an error occurs.

fileID

void fileID(String fileID)
     throws jpos.JposException

Final part of setting FileID. 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 open,
• fileID is not null,
• internal property AllowAlwaysSetProperties is true or fileID equals the previous value of FileID.

Parameters:

fileID - New value for FileID property.

Throws:

jpos.JposException - If an error occurs.

fileIndex

void fileIndex(int fileIndex)
        throws jpos.JposException

Final part of setting FileIndex. 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 open,
• internal property AllowAlwaysSetProperties is true or fileIndex equals the previous value of FileIndex.

Parameters:

fileIndex - New value for FileIndex property.

Throws:

jpos.JposException - If an error occurs.

imageFormat

void imageFormat(int imageFormat)
          throws jpos.JposException

Final part of setting ImageFormat. 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 open,
• imageFormat is one of IF_NATIVE, IF_TIFF, IF_BMP, IF_JPEG, or IF_GIF,
• the corresponding bit in CapImageFormat (CIF_NATIVE, ...) is set,
• internal property AllowAlwaysSetProperties is true or imageFormat equals the previous value of ImageFormat.

Parameters:

imageFormat - New value for ImageFormat property.

Throws:

jpos.JposException - If an error occurs.

imageTagData

void imageTagData(String imageTagData)
           throws jpos.JposException

Final part of setting ImageTagData. 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 open,
• imageTagData is not null,
• internal property AllowAlwaysSetProperties is true or imageTagData equals the previous value of ImageTagData.

Parameters:

imageTagData - New value for ImageTagData property.

Throws:

jpos.JposException - If an error occurs.

mapMode

void mapMode(int mapMode)
      throws jpos.JposException

Final part of setting MapMode. 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 open,
• mapMode is one of MM_DOTS, MM_TWIPS, MM_ENGLISH or MM_METRIC,
• internal property AllowAlwaysSetProperties is true or mapMode equals the previous value of MapMode.

Parameters:

mapMode - New value for MapMode property.

Throws:

jpos.JposException - If an error occurs.

quality

void quality(int quality)
      throws jpos.JposException

Final part of setting Quality. 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 open,
• quality is one of the values stored in the QualityList property,
• internal property AllowAlwaysSetProperties is true or quality equals the previous value of Quality.

Parameters:

quality - New value for Quality property.

Throws:

jpos.JposException - If an error occurs.

beginInsertion

void beginInsertion(int timeout)
             throws jpos.JposException

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

• Device is enabled,
• timeout is positive or 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 - Maximum time in milliseconds BeginInsertion delays execution.

Throws:

jpos.JposException - If an error occurs or in case of a timeout.

beginRemoval

void beginRemoval(int timeout)
           throws jpos.JposException

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

• Device is enabled,
• timeout is positive or 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 - Maximum time in milliseconds BeginRemoval delays execution.

Throws:

jpos.JposException - If an error occurs or in case of a timeout.

clearImage

void clearImage(int by)
         throws jpos.JposException

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

• Device is enabled,
• by is one of CLR_ALL, CLR_BY_FILEID, CLR_BY_FILEINDEX or CLR_BY_IMAGETAGDATA.

Parameters:

by - One of CLR_ALL, CLR_BY_FILEID, CLR_BY_FILEINDEX or CLR_BY_IMAGETAGDATA, specifies which properties will be used to access the device's image storage.

Throws:

jpos.JposException - If an error occurs.

defineCropArea

void defineCropArea(int cropAreaID,
 int x,
 int y,
 int cx,
 int cy)
             throws jpos.JposException

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

• Device is enabled,
• cropAreaID equals CROP_AREA_RESET_ALL or
  • CapDefineCropArea is true,
  • x between 0 and DocumentWidth,
  • y between 0 and DocumentHeight,
  • cx between 0 and DocumentWidth - x and
  • cy between 0 and DocumentHeight - y.
  Remark: If cx equals CROP_AREA_RIGHT or cy equals CROP_AREA_BOTTOM, the service computes the corresponding real cx or cy value from the corresponding image dimensions using the current MapMode.

Parameters:

cropAreaID - Crop area identifier to be used.

x - Starting x coordinate of the cropping area.

y - Starting y coordinate of the cropping area.

cx - Value to be added to x coordinate to compute the ending x coordinate of the cropping area.

cy - Value to be added to y coordinate to compute the ending y coordinate of the cropping area.

Throws:

jpos.JposException - If an error occurs.

endInsertion

void endInsertion()
           throws jpos.JposException

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

• Device is enabled,
• Device entered insertion mode previously.

Throws:

jpos.JposException - If an error occurs.

endRemoval

void endRemoval()
         throws jpos.JposException

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

• Device is enabled,
• Device entered removal mode previously.

Throws:

jpos.JposException - If an error occurs.

retrieveImage

void retrieveImage(int cropAreaID)
            throws jpos.JposException

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

• Device is enabled,
• cropAreaID equals CROP_AREA_ENTIRE_IMAGE or CapDefineCropArea is true,
• Device is neither in insertion nor in removal mode (no outstanding EndInsertion or EndRemoval).

Parameters:

cropAreaID - Crop area ID as specified in DefineCropArea or CROP_AREA_ENTIRE_IMAGE.

Throws:

jpos.JposException - If an error occurs.

retrieveMemory

void retrieveMemory(int by)
             throws jpos.JposException

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

• Device is enabled,
• CapStoreImageFiles is true,
• by equals LOCATE_BY_FILEID and FileID is a non-empty string or
• by equals LOCATE_BY_FILEINDEX or
• by equals LOCATE_BY_IMAGETAGDATA, CapImageTagData is true and ImageTagData is a non-empty string.

Parameters:

by - One of LOCATE_BY_FILEID, LOCATE_BY_FILEINDEX or LOCATE_BY_IMAGETAGDATA.

Throws:

jpos.JposException - If an error occurs.

storeImage

void storeImage(int cropAreaID)
         throws jpos.JposException

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

• Device is enabled,
• CapStoreImageFiles is true,
• CapDefineCropArea is true or cropAreaID equals CROP_AREA_ENTIRE_IMAGE.

Parameters:

cropAreaID - Crop area ID as specified in DefineCropArea or CROP_AREA_ENTIRE_IMAGE.

Throws:

jpos.JposException - If an error occurs.