Package de.gmxhome.conrad.jpos.jpos_base.billdispenser

Class BillDispenserProperties

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

  • Field Details

    • AsyncResultCode

      public int AsyncResultCode
      UPOS property AsyncResultCode. Default: STATUS_OK. Will be set when throwing a BillDispenserStatusUpdateEvent with STATUS_ASYNC.

    • AsyncResultCodeExtended

      public int AsyncResultCodeExtended
      UPOS property AsyncResultCodeExtended. Default: 0. Will be set when throwing a BillDispenserStatusUpdateEvent with STATUS_ASYNC.

    • CapDiscrepancy

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

    • CapEmptySensor

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

    • CapNearEmptySensor

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

    • CurrencyCashList

      public String CurrencyCashList
      UPOS property CurrencyCashList. Default: null. Must 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.

    • CurrencyCodeList

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

    • CurrentExit

      public int CurrentExit
      UPOS property CurrentExit. Default: 1. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • DeviceExits

      public int DeviceExits
      UPOS property DeviceExits. Default: 1. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • DeviceStatus

      public Integer DeviceStatus
      UPOS property DeviceStatus.

    • DeviceStatusDef

      public Integer DeviceStatusDef
      Default value of DeviceStatus property. Default: null. Must be updated before calling initOnEnable the first time.

    • ExitCashList

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

  • Constructor Details

    • BillDispenserProperties

      protected BillDispenserProperties​(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: BillDispenserInterface
      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 CurrencyCodeList,
      • internal property AllowAlwaysSetProperties is true or code equals the previous value of CurrencyCode.
      Specified by:
      currencyCode in interface BillDispenserInterface
      Parameters:
      code - New value for CurrencyCode property.
      Throws:
      jpos.JposException - If an error occurs.

    • currentExit

      public void currentExit​(int i) throws jpos.JposException
      Description copied from interface: BillDispenserInterface
      Final part of setting CurrentExit. 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,
      • i is neither less than one nor greater than DeviceExits.
      Specified by:
      currentExit in interface BillDispenserInterface
      Parameters:
      i - New value for CurrentExit property.
      Throws:
      jpos.JposException - If an error occurs.

    • adjustCashCounts

      public void adjustCashCounts​(String cashCounts) throws jpos.JposException
      Description copied from interface: BillDispenserInterface
      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 BillDispenserInterface
      Parameters:
      cashCounts - The cashCounts parameter contains cash types and amounts to be initialized.
      Throws:
      jpos.JposException - If an error occurs.

    • readCashCounts

      public void readCashCounts​(String[] cashCounts, boolean[] discrepancy) throws jpos.JposException
      Description copied from interface: BillDispenserInterface
      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 is not null and has dimension 1,
      • discrepancy is not null and has dimension 1.
      Specified by:
      readCashCounts in interface BillDispenserInterface
      Parameters:
      cashCounts - The cash count data is placed into cashCounts.
      discrepancy - Specifies whether there is some cash which could not to be included in the counts reported.
      Throws:
      jpos.JposException - If an error occurs.

    • dispenseCash

      public DispenseCash dispenseCash​(String cashCounts) throws jpos.JposException
      Description copied from interface: BillDispenserInterface
      Validation part of DispenseCash method. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • all previous DispenseCash operations have been finished,
      • 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:
      dispenseCash in interface BillDispenserInterface
      Parameters:
      cashCounts - The cashCounts parameter contains the dispensing cash units and counts.
      Returns:
      DispenseCash object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • dispenseCash

      public void dispenseCash​(DispenseCash request) throws jpos.JposException
      Description copied from interface: BillDispenserInterface
      Final part of DispenseCash method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a DispenseCash object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
      Specified by:
      dispenseCash in interface BillDispenserInterface
      Parameters:
      request - Output request object returned by validation method that contains all parameters to be used by DispenseCash.
      Throws:
      jpos.JposException - If an error occurs.