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

Interface BillDispenserInterface

All Superinterfaces:
JposBaseInterface
All Known Implementing Classes:
BillDispenserProperties
public interface BillDispenserInterface extends JposBaseInterface
Interface for methods that implement property setter and method calls for the BillDispenser device category. For details about properties, methods and method parameters, see UPOS specification, chapter Bill Dispenser. Further details about error handling can be found in introduction - Device Behavior Models - Errors.

  • 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 CurrencyCodeList,
      • 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.

    • currentExit

      void currentExit​(int i) throws jpos.JposException
      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.
      Parameters:
      i - New value for CurrentExit 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 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.
      Parameters:
      cashCounts - The cashCounts parameter contains cash types and amounts to be initialized.
      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 is not null and has dimension 1,
      • discrepancy is not null and has dimension 1.
      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

      DispenseCash dispenseCash​(String cashCounts) throws jpos.JposException
      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.
      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

      void dispenseCash​(DispenseCash request) throws jpos.JposException
      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.
      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.