Package de.gmxhome.conrad.jpos.jpos_base.gate

Interface GateInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

GateProperties

public interface GateInterface
extends JposBaseInterface

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

Method Summary

Modifier and Type	Method	Description
void	openGate()	Final part of OpenGate method.
void	waitForGateClose(int timeout)	Final part of WaitForGateClose 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

openGate

void openGate()
       throws jpos.JposException

Final part of OpenGate 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 has not been claimed by other instance.

Throws:

jpos.JposException - If an error occurs.

waitForGateClose

void waitForGateClose(int timeout)
               throws jpos.JposException

Final part of WaitForGateClose 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,
• CapStatus is true,
• timeout is a positive value or FOREVER.

Parameters:

timeout - Number of milliseconds to wait before firing an exception with JPOS_E_TIMEOUT.

Throws:

jpos.JposException - If an error or a timeout occurs.