Package de.gmxhome.conrad.jpos.jpos_base.coinacceptor

Interface CoinAcceptorInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

CoinAcceptorProperties

public interface CoinAcceptorInterface
extends JposBaseInterface

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

Method Summary

Modifier and Type	Method	Description
void	adjustCashCounts(String cashCounts)	Final part of AdjustCashCounts method.
void	beginDeposit()	Final part of BeginDeposit method.
void	currencyCode(String code)	Final part of setting CurrencyCode.
void	endDeposit(int success)	Final part of EndDeposit method.
void	fixDeposit()	Final part of FixDeposit method.
void	pauseDeposit(int control)	Final part of PauseDeposit method.
void	readCashCounts(String[] cashCounts, boolean[] discrepancy)	Final part of ReadCashCounts method.
void	realTimeDataEnabled(boolean flag)	Final part of setting RealTimeDataEnabled.

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

currencyCode

void currencyCode(String code)
           throws jpos.JposException

Final part of setting CurrencyCode. 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,
• code is one of the values specified in DepositCodeList,
• internal property AllowAlwaysSetProperties is true or code equals the previous value of CurrencyCode.

Parameters:

code - New value for CurrencyCode property.

Throws:

jpos.JposException - If an error occurs.

realTimeDataEnabled

void realTimeDataEnabled(boolean flag)
                  throws jpos.JposException

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 is enabled,
• CapRealTimeData is true or flag is false.

Parameters:

flag - New value for RealTimeDataEnabled property.

Throws:

jpos.JposException - If an error occurs.

adjustCashCounts

void adjustCashCounts(String cashCounts)
               throws jpos.JposException

Final part of AdjustCashCounts 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,
• cashCounts consists of a comma separated, not empty list of integer value pairs separated by double-point.

Parameters:

cashCounts - The cashCounts parameter contains cash types and amounts to be initialized.

Throws:

jpos.JposException - If an error occurs.

beginDeposit

void beginDeposit()
           throws jpos.JposException

Final part of BeginDeposit 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,
• DepositStatus is STATUS_DEPOSIT_END.

Throws:

jpos.JposException - If an error occurs.

endDeposit

void endDeposit(int success)
         throws jpos.JposException

Final part of EndDeposit 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,
• DepositStatus is STATUS_DEPOSIT_COUNT,
• success is DEPOSIT_COMPLETE.

Parameters:

success - The success parameter holds the value of how to deal with the cash that was deposited. Must be DEPOSIT_COMPLETE.

Throws:

jpos.JposException - If an error occurs.

fixDeposit

void fixDeposit()
         throws jpos.JposException

Final part of FixDeposit 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,
• DepositStatus is STATUS_DEPOSIT_START.

Throws:

jpos.JposException - If an error occurs.

pauseDeposit

void pauseDeposit(int control)
           throws jpos.JposException

Final part of PauseDeposit 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,
• CapPauseDeposit is true,
• control is DEPOSIT_PAUSE or DEPOSIT_RESTART,
• if control is DEPOSIT_PAUSE, DepositStatus is not STATUS_DEPOSIT_END.

Parameters:

control - The control parameter contains one of DEPOSIT_PAUSE and DEPOSIT_RESTART.

Throws:

jpos.JposException - If an error occurs.

readCashCounts

void readCashCounts(String[] cashCounts,
 boolean[] discrepancy)
             throws jpos.JposException

Final part of ReadCashCounts 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,
• cashCounts and discrepancy are arrays with length one.

Parameters:

cashCounts - The cash count data is placed into cashCounts.

discrepancy - Reports whether not all counts could be updated as requested.

Throws:

jpos.JposException - If an error occurs.