Package de.gmxhome.conrad.jpos.jpos_base.signaturecapture

Class SignatureCaptureProperties

java.lang.Object

de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties

de.gmxhome.conrad.jpos.jpos_base.signaturecapture.SignatureCaptureProperties

All Implemented Interfaces:

JposBaseInterface, SignatureCaptureInterface

public class SignatureCaptureProperties
extends JposCommonProperties
implements SignatureCaptureInterface

Class containing the signature capture specific properties, their default values and default implementations of SignatureCaptureInterface. For details about properties, methods and method parameters, see UPOS specification, chapter Signature Capture.

Field Summary

Fields

Modifier and Type	Field	Description
boolean	CapDisplay	UPOS property CapDisplay.
boolean	CapRealTimeData	UPOS property CapRealTimeData.
boolean	CapUserTerminated	UPOS property CapUserTerminated.
int	MaximumX	UPOS property MaximumX.
int	MaximumY	UPOS property MaximumY.
Point[]	PointArray	UPOS property PointArray.
byte[]	RawData	UPOS property RawData.
boolean	RealTimeDataEnabled	UPOS property RealTimeDataEnabled.

Fields inherited from class de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties

AllowAlwaysSetProperties, AllowDeprecatedMethods, AsyncInputActive, AsyncMode, AutoDisable, CapStatisticsReporting, CapUpdateStatistics, CheckHealthText, Claimed, Claiming, ClaimWaiters, CurrentCommands, CurrentUnitID, DataCount, DataEventEnabled, DataEventList, Device, DeviceEnabled, DeviceServiceDescription, DeviceServiceVersion, DevProps, ErrorString, ErrorUnits, EventCB, EventList, EventSource, EventString, EventUnitID, EventUnits, ExclusiveAllowed, ExclusiveNo, ExclusiveUse, ExclusiveYes, FirstEnableHappened, FlagWhenIdle, FlagWhenIdleStatusValue, FreezeEvents, Index, LogicalName, MaximumConfirmationEventWaitingTime, OutputID, PowerNotify, PowerState, SerializedRequestRunner, SerializedRequests, State, StrictFIFOEventHandling, SuspendedCommands, SuspendedConcurrentCommands, UnitsOnline, UsesSubsystemUnits

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SignatureCaptureProperties(int dev)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	beginCapture(String formName)	Final part of BeginCapture method.
void	endCapture()	Final part of EndCapture method.
void	realTimeDataEnabled(boolean flag)	Final part of setting RealTimeDataEnabled.

Methods inherited from class de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties

addProperties, asyncMode, attachWaiter, autoDisable, checkForDeprecation, checkHealth, checkProperties, claim, clearDataProperties, clearErrorProperties, clearInput, clearOutput, clearOutputErrorProperties, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, getClaimingInstance, handlePowerStateOnEnable, initOnClaim, initOnEnable, initOnFirstEnable, initOnOpen, newJposOutputRequest, open, powerNotify, release, releaseWaiter, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, signalWaiter, unitDataCount, updateFirmware, updateFirmware, updateStatistics, waitWaiter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Field Details

CapDisplay

public boolean CapDisplay

UPOS property CapDisplay. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

CapRealTimeData

public boolean CapRealTimeData

UPOS property CapRealTimeData. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

CapUserTerminated

public boolean CapUserTerminated

UPOS property CapUserTerminated. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

MaximumX

public int MaximumX

UPOS property MaximumX. Default: 0. Must be overwritten by objects derived from JposDevice within the changeDefaults method.

MaximumY

public int MaximumY

UPOS property MaximumY. Default: 0. Must be overwritten by objects derived from JposDevice within the changeDefaults method.

PointArray

public Point[] PointArray

UPOS property PointArray. Default: null (no data). Must be overwritten before delivering a data event.

RawData

public byte[] RawData

UPOS property RawData. Default: null (no data). Must be overwritten before delivering a data event.

RealTimeDataEnabled

public boolean RealTimeDataEnabled

UPOS property RealTimeDataEnabled. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

Constructor Details

SignatureCaptureProperties

protected SignatureCaptureProperties(int dev)

Constructor.

Parameters:

dev - Device index

Method Details

realTimeDataEnabled

public void realTimeDataEnabled(boolean flag)
                         throws jpos.JposException

Description copied from interface: SignatureCaptureInterface

Final part of setting RealTimeDataEnabled. 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 has been opened,
• The new property value is false or CapRealTimeData is true,
• internal property AllowAlwaysSetProperties is true or flag equals the previous value of RealTimeDataEnabled.

Specified by:

realTimeDataEnabled in interface SignatureCaptureInterface

Parameters:

flag - New property value.

Throws:

jpos.JposException - If an error occurs.

beginCapture

public void beginCapture(String formName)
                  throws jpos.JposException

Description copied from interface: SignatureCaptureInterface

Final part of BeginCapture 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.

Specified by:

beginCapture in interface SignatureCaptureInterface

Parameters:

formName - Identifier for signature capture form.

Throws:

jpos.JposException - If an error occurs.

endCapture

public void endCapture()
                throws jpos.JposException

Description copied from interface: SignatureCaptureInterface

Final part of EndCapture 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.

Specified by:

endCapture in interface SignatureCaptureInterface

Throws:

jpos.JposException - If an error occurs.