Package de.gmxhome.conrad.jpos.jpos_base.billacceptor

Class BillAcceptorProperties

java.lang.Object
de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties
de.gmxhome.conrad.jpos.jpos_base.billacceptor.BillAcceptorProperties
All Implemented Interfaces:
BillAcceptorInterface, JposBaseInterface
public class BillAcceptorProperties extends JposCommonProperties implements BillAcceptorInterface
Class containing the bill acceptor specific properties, their default values and default implementations of BillAcceptorInterface. For details about properties, methods and method parameters, see UPOS specification, chapter Bill Acceptor.

  • Field Details

    • CapDiscrepancy

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

    • CapFullSensor

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

    • CapJamSensor

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

    • CapNearFullSensor

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

    • CapPauseDeposit

      public boolean CapPauseDeposit
      UPOS property CapPauseDeposit. 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.

    • CurrencyCode

      public String CurrencyCode
      UPOS property CurrencyCode. Default: null. Must be overwritten by objects derived from JposDevice within the changeDefaults method.

    • DepositAmount

      public int DepositAmount
      UPOS property DepositAmount. Default: 0.

    • DepositCashList

      public String DepositCashList
      UPOS property DepositCashList. Default: null. Must be overwritten by objects derived from JposDevice within the changeDefaults method.

    • DepositCodeList

      public String DepositCodeList
      UPOS property DepositCodeList. Default: null. Must be overwritten by objects derived from JposDevice within the changeDefaults method.

    • DepositCounts

      public String DepositCounts
      UPOS property DepositCounts. Default: null. Must be overwritten by objects derived from JposDevice within the changeDefaults method.

    • DepositStatus

      public int DepositStatus
      UPOS property DepositStatus.

    • DepositStatusDef

      public int DepositStatusDef
      Default value of DepositStatus property. Default: STATUS_DEPOSIT_END. Should be updated before calling initOnEnable the first time.

    • FullStatus

      public Integer FullStatus
      UPOS property FullStatus.

    • FullStatusDef

      public Integer FullStatusDef
      Default value of FullStatus property. Default: null. Must be overwritten before calling initOnEnable the first time.

    • RealTimeDataEnabled

      public boolean RealTimeDataEnabled
      UPOS property RealTimeDataEnabled. Default: false.

  • Constructor Details

    • BillAcceptorProperties

      protected BillAcceptorProperties​(int dev)
      Constructor.
      Parameters:
      dev - Device index

  • Method Details

    • initOnEnable

      public void initOnEnable​(boolean enable)
      Description copied from class: JposCommonProperties
      Initialization of properties that must be initialized during deviceEnable.
      Overrides:
      initOnEnable in class JposCommonProperties
      Parameters:
      enable - True: initialize properties, false: do nothing

    • currencyCode

      public void currencyCode​(String code) throws jpos.JposException
      Description copied from interface: BillAcceptorInterface
      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.
      Specified by:
      currencyCode in interface BillAcceptorInterface
      Parameters:
      code - New value for CurrencyCode property.
      Throws:
      jpos.JposException - If an error occurs.

    • realTimeDataEnabled

      public void realTimeDataEnabled​(boolean flag) throws jpos.JposException
      Description copied from interface: BillAcceptorInterface
      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.
      Specified by:
      realTimeDataEnabled in interface BillAcceptorInterface
      Parameters:
      flag - New value for RealTimeDataEnabled property.
      Throws:
      jpos.JposException - If an error occurs.

    • adjustCashCounts

      public void adjustCashCounts​(String cashCounts) throws jpos.JposException
      Description copied from interface: BillAcceptorInterface
      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 start with ";" to indicate adjustment of bills,
      • the remainder of cashCounts consists of a comma separated, not empty list of integer value pairs separated by double-point.
      Specified by:
      adjustCashCounts in interface BillAcceptorInterface
      Parameters:
      cashCounts - The cashCounts parameter contains cash types and amounts to be initialized.
      Throws:
      jpos.JposException - If an error occurs.

    • beginDeposit

      public void beginDeposit() throws jpos.JposException
      Default implementation of BeginDeposit simply sets DepositStatus to STATUS_DEPOSIT_START.
      Specified by:
      beginDeposit in interface BillAcceptorInterface
      Throws:
      jpos.JposException - never.

    • endDeposit

      public void endDeposit​(int success) throws jpos.JposException
      Default implementation of EndDeposit simply sets DepositStatus to STATUS_DEPOSIT_END.
      Specified by:
      endDeposit in interface BillAcceptorInterface
      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 - never.

    • fixDeposit

      public void fixDeposit() throws jpos.JposException
      Default implementation of FixDeposit simply sets DepositStatus to STATUS_DEPOSIT_COUNT.
      Specified by:
      fixDeposit in interface BillAcceptorInterface
      Throws:
      jpos.JposException - never.

    • pauseDeposit

      public void pauseDeposit​(int control) throws jpos.JposException
      Description copied from interface: BillAcceptorInterface
      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.
      Specified by:
      pauseDeposit in interface BillAcceptorInterface
      Parameters:
      control - The control parameter contains one of DEPOSIT_PAUSE and DEPOSIT_RESTART.
      Throws:
      jpos.JposException - If an error occurs.

    • readCashCounts

      public void readCashCounts​(String[] cashCounts, boolean[] discrepancy) throws jpos.JposException
      Description copied from interface: BillAcceptorInterface
      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.
      Specified by:
      readCashCounts in interface BillAcceptorInterface
      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.