Package de.gmxhome.conrad.jpos.jpos_base.cat

Interface CATInterface

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

  • Method Details

    • additionalSecurityInformation

      void additionalSecurityInformation​(String addInfo) throws jpos.JposException
      Final part of setting AdditionalSecurityInformation. 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,
      • CapAdditionalSecurityInformation is true,
      • internal property AllowAlwaysSetProperties is true or addInfo equals the previous value of AdditionalSecurityInformation.
      Parameters:
      addInfo - AdditionalSecurityInformation for subsequent storing data into journal.
      Throws:
      jpos.JposException - If an error occurs.

    • paymentMedia

      void paymentMedia​(int media) throws jpos.JposException
      Final part of setting PaymentMedia. 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,
      • media is one of MEDIA_UNSPECIFIED, MEDIA_CREDIT, MEDIA_DEBIT or MEDIA_ELECTRONIC_MONEY,
      • internal property AllowAlwaysSetProperties is true or media equals the previous value of PaymentMedia.
      Parameters:
      media - PaymentMedia for subsequent storing data into journal.
      Throws:
      jpos.JposException - If an error occurs.

    • trainingMode

      void trainingMode​(boolean flag) throws jpos.JposException
      Final part of setting TrainingMode. 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,
      • CapTrainingMode is true or flag is false,
      • internal property AllowAlwaysSetProperties is true or flag equals the previous value of TrainingMode.
      Parameters:
      flag - TrainingMode for subsequent storing data into journal.
      Throws:
      jpos.JposException - If an error occurs.

    • accessDailyLog

      AccessDailyLog accessDailyLog​(int sequenceNumber, int type, int timeout) throws jpos.JposException
      Validation part of AccessDailyLog 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,
      • Device is not busy,
      • type is one of DL_REPORTING or DL_SETTLEMENT and is contained in CapDailyLog,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      sequenceNumber - Sequence number, any value.
      type - DL_REPORTING or DL_SETTLEMENT.
      timeout - operation timeout.
      Returns:
      AccessDailyLog object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • accessDailyLog

      void accessDailyLog​(AccessDailyLog request) throws jpos.JposException
      Final part of AccessDailyLog method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a AccessDailyLog 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 AccessDailyLog.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizeCompletion

      AuthorizeCompletion authorizeCompletion​(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Validation part of AuthorizeCompletion 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,
      • Device is not busy,
      • CapAuthorizeCompletion is true,
      • amount > 0, taxOthers $ge; 0,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      sequenceNumber - Sequence number, any value.
      amount - Purchase amount for approval.
      taxOthers - Tax and other amounts for approval.
      timeout - operation timeout.
      Returns:
      AuthorizeCompletion object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizeCompletion

      void authorizeCompletion​(AuthorizeCompletion request) throws jpos.JposException
      Final part of AuthorizeCompletion method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a AuthorizeCompletion 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 AuthorizeCompletion.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizePreSales

      AuthorizePreSales authorizePreSales​(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Validation part of AuthorizePreSales 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,
      • Device is not busy,
      • CapAuthorizePreSales is true,
      • amount > 0, taxOthers $ge; 0,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      sequenceNumber - Sequence number, any value.
      amount - Purchase amount for approval.
      taxOthers - Tax and other amounts for approval.
      timeout - operation timeout.
      Returns:
      AuthorizePreSales object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizePreSales

      void authorizePreSales​(AuthorizePreSales request) throws jpos.JposException
      Final part of AuthorizePreSales method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a AuthorizePreSales 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 AuthorizePreSales.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizeRefund

      AuthorizeRefund authorizeRefund​(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Validation part of AuthorizeRefund 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,
      • Device is not busy,
      • CapAuthorizeRefund is true,
      • amount > 0, taxOthers $ge; 0,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      sequenceNumber - Sequence number, any value.
      amount - Purchase amount for approval.
      taxOthers - Tax and other amounts for approval.
      timeout - operation timeout.
      Returns:
      AuthorizeRefund object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizeRefund

      void authorizeRefund​(AuthorizeRefund request) throws jpos.JposException
      Final part of AuthorizeRefund method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a AuthorizeRefund 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 AuthorizeRefund.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizeSales

      AuthorizeSales authorizeSales​(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Validation part of AuthorizeSales 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,
      • Device is not busy,
      • amount > 0, taxOthers $ge; 0,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      sequenceNumber - Sequence number, any value.
      amount - Purchase amount for approval.
      taxOthers - Tax and other amounts for approval.
      timeout - operation timeout.
      Returns:
      AuthorizeSales object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizeSales

      void authorizeSales​(AuthorizeSales request) throws jpos.JposException
      Final part of AuthorizeSales method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a AuthorizeSales 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 AuthorizeSales.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizeVoid

      AuthorizeVoid authorizeVoid​(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Validation part of AuthorizeVoid 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,
      • Device is not busy,
      • CapAuthorizeVoid is true,
      • amount > 0, taxOthers $ge; 0,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      sequenceNumber - Sequence number, any value.
      amount - Purchase amount for approval.
      taxOthers - Tax and other amounts for approval.
      timeout - operation timeout.
      Returns:
      AuthorizeVoid object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizeVoid

      void authorizeVoid​(AuthorizeVoid request) throws jpos.JposException
      Final part of AuthorizeVoid method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a AuthorizeVoid 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 AuthorizeVoid.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizeVoidPreSales

      AuthorizeVoidPreSales authorizeVoidPreSales​(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Validation part of AuthorizeVoidPreSales 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,
      • Device is not busy,
      • CapAuthorizeVoidPreSales is true,
      • amount > 0, taxOthers $ge; 0,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      sequenceNumber - Sequence number, any value.
      amount - Purchase amount for approval.
      taxOthers - Tax and other amounts for approval.
      timeout - operation timeout.
      Returns:
      AuthorizeVoidPreSales object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • authorizeVoidPreSales

      void authorizeVoidPreSales​(AuthorizeVoidPreSales request) throws jpos.JposException
      Final part of AuthorizeVoidPreSales method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a AuthorizeVoidPreSales 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 AuthorizeVoidPreSales.
      Throws:
      jpos.JposException - If an error occurs.

    • cashDeposit

      CashDeposit cashDeposit​(int sequenceNumber, long amount, int timeout) throws jpos.JposException
      Validation part of CashDeposit 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,
      • Device is not busy,
      • CapCashDeposit is true,
      • amount > 0,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      sequenceNumber - Sequence number, any value.
      amount - Purchase amount for approval.
      timeout - operation timeout.
      Returns:
      CashDeposit object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • cashDeposit

      void cashDeposit​(CashDeposit request) throws jpos.JposException
      Final part of CashDeposit method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a CashDeposit 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 CashDeposit.
      Throws:
      jpos.JposException - If an error occurs.

    • checkCard

      CheckCard checkCard​(int sequenceNumber, int timeout) throws jpos.JposException
      Validation part of CheckCard 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,
      • Device is not busy,
      • CapCheckCard is true,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      sequenceNumber - Sequence number, any value.
      timeout - operation timeout.
      Returns:
      CheckCard object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • checkCard

      void checkCard​(CheckCard request) throws jpos.JposException
      Final part of CheckCard method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a CheckCard 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 CheckCard.
      Throws:
      jpos.JposException - If an error occurs.

    • lockTerminal

      LockTerminal lockTerminal() throws jpos.JposException
      Validation part of LockTerminal 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,
      • Device is not busy,
      • CapLockTerminal is true,
      • timeout is JPOS_FOREVER or ≥ 0.
      Returns:
      LockTerminal object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • lockTerminal

      void lockTerminal​(LockTerminal request) throws jpos.JposException
      Final part of LockTerminal method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a LockTerminal 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 to be used by LockTerminal.
      Throws:
      jpos.JposException - If an error occurs.

    • unlockTerminal

      UnlockTerminal unlockTerminal() throws jpos.JposException
      Validation part of UnlockTerminal 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,
      • Device is not busy,
      • CapUnlockTerminal is true,
      • timeout is JPOS_FOREVER or ≥ 0.
      Returns:
      UnlockTerminal object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • unlockTerminal

      void unlockTerminal​(UnlockTerminal request) throws jpos.JposException
      Final part of UnlockTerminal method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a UnlockTerminal 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 to be used by UnlockTerminal.
      Throws:
      jpos.JposException - If an error occurs.