Package de.gmxhome.conrad.jpos.jpos_base.imagescanner

Interface ImageScannerInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

ImageScannerProperties

public interface ImageScannerInterface
extends JposBaseInterface

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

Method Summary

Modifier and Type	Method	Description
void	aimMode(boolean aimMode)	Final part of setting AimMode.
void	illuminateMode(boolean illuminateMode)	Final part of setting IlluminateMode.
void	imageMode(int imageMode)	Final part of setting ImageMode.
void	imageQuality(int imageQuality)	Final part of setting ImageQuality.
void	startSession()	Final part of StartSession method.
void	stopSession()	Final part of StopSession method.
void	videoCount(int videoCount)	Final part of setting VideoCount.
void	videoRate(int videoRate)	Final part of setting VideoRate.

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

aimMode

void aimMode(boolean aimMode)
      throws jpos.JposException

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

Parameters:

aimMode - New value for AimMode property.

Throws:

jpos.JposException - If an error occurs.

illuminateMode

void illuminateMode(boolean illuminateMode)
             throws jpos.JposException

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

Parameters:

illuminateMode - New value for IlluminateMode property.

Throws:

jpos.JposException - If an error occurs.

imageMode

void imageMode(int imageMode)
        throws jpos.JposException

Final part of setting ImageMode. 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,
• imageMode is one of DECODE_ONLY, STILL_ONLY, STILL_DECODE, VIDEO_DECODE, VIDEO_STILL or ALL,
• imageMode matches the capabilities CapDecodeData, CapImageData and CapVideoData,
• internal property AllowAlwaysSetProperties is true or imageMode equals the previous value of ImageMode.

Parameters:

imageMode - New value for ImageMode property.

Throws:

jpos.JposException - If an error occurs.

imageQuality

void imageQuality(int imageQuality)
           throws jpos.JposException

Final part of setting ImageQuality. 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,
• imageQuality is one of QUAL_LOW, QUAL_MED or QUAL_HIGH,
• if CapImageQuality is false, imageQuality equals the previous property value,
• internal property AllowAlwaysSetProperties is true or imageQuality equals the previous value of ImageQuality.

Parameters:

imageQuality - New value for ImageQuality property.

Throws:

jpos.JposException - If an error occurs.

videoCount

void videoCount(int videoCount)
         throws jpos.JposException

Final part of setting VideoCount. 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,
• videoRate is a positive value,
• internal property AllowAlwaysSetProperties is true or videoCount equals the previous value of VideoCount.

Parameters:

videoCount - New value for VideoCount property.

Throws:

jpos.JposException - If an error occurs.

videoRate

void videoRate(int videoRate)
        throws jpos.JposException

Final part of setting VideoRate. 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,
• videoRate is a positive value,
• internal property AllowAlwaysSetProperties is true or videoRate equals the previous value of VideoRate.

Parameters:

videoRate - New value for VideoRate property.

Throws:

jpos.JposException - If an error occurs.

startSession

void startSession()
           throws jpos.JposException

Final part of StartSession 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,
• CapHostTriggered is true.

Throws:

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

stopSession

void stopSession()
          throws jpos.JposException

Final part of StopSession 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,
• CapHostTriggered is true.

Throws:

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