Class CATProperties

java.lang.Object
de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties
de.gmxhome.conrad.jpos.jpos_base.cat.CATProperties
All Implemented Interfaces:
CATInterface, JposBaseInterface
Direct Known Subclasses:
CAT

public class CATProperties extends JposCommonProperties implements CATInterface
Class containing the CAT specific properties, their default values and default implementations of CATInterface. For details about properties, methods and method parameters, see UPOS specification, chapter CAT - Credit Authorization Terminal.
  • Field Details

    • AccountNumber

      public String AccountNumber
      UPOS property AccountNumber.
    • AdditionalSecurityInformation

      public String AdditionalSecurityInformation
      UPOS property AdditionalSecurityInformation. Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • ApprovalCode

      public String ApprovalCode
      UPOS property ApprovalCode.
    • Balance

      public long Balance
      UPOS property Balance. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • CapAdditionalSecurityInformation

      public boolean CapAdditionalSecurityInformation
      UPOS property CapAdditionalSecurityInformation. Default: true. Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • CapAuthorizeCompletion

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

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

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

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

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

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

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

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

      public int CapDailyLog
      UPOS property CapDailyLog. Default: DL_NONE. Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • CapInstallments

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

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

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

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

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

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

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

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

      public String CardCompanyID
      UPOS property CardCompanyID.
    • CenterResultCode

      public String CenterResultCode
      UPOS property CenterResultCode.
    • DailyLog

      public String DailyLog
      UPOS property DailyLog. Default: "". Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • LogStatus

      public int LogStatus
      UPOS property LogStatus. Default: LOGSTATUS_OK. Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • PaymentCondition

      public int PaymentCondition
      UPOS property PaymentCondition. Default: PAYMENT_DEBIT. Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • PaymentDetail

      public String PaymentDetail
      UPOS property PaymentDetail.
    • PaymentMedia

      public int PaymentMedia
      UPOS property PaymentMedia.
    • SequenceNumber

      public int SequenceNumber
      UPOS property SequenceNumber.
    • SettledAmount

      public long SettledAmount
      UPOS property SettledAmount. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • SlipNumber

      public String SlipNumber
      UPOS property SlipNumber.
    • TrainingMode

      public boolean TrainingMode
      UPOS property TrainingMode.
    • TransactionNumber

      public String TransactionNumber
      UPOS property TransactionNumber.
    • TransactionType

      public int TransactionType
      UPOS property TransactionType.
  • Constructor Details

    • CATProperties

      public CATProperties(int dev)
      Constructor.
      Parameters:
      dev - Device index
  • Method Details

    • initOnOpen

      public void initOnOpen()
      Description copied from class: JposCommonProperties
      Initialization of properties that must be initialized during open.
      Overrides:
      initOnOpen in class JposCommonProperties
    • additionalSecurityInformation

      public void additionalSecurityInformation(String addInfo) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      additionalSecurityInformation in interface CATInterface
      Parameters:
      addInfo - AdditionalSecurityInformation for subsequent storing data into journal.
      Throws:
      jpos.JposException - If an error occurs.
    • paymentMedia

      public void paymentMedia(int media) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      paymentMedia in interface CATInterface
      Parameters:
      media - PaymentMedia for subsequent storing data into journal.
      Throws:
      jpos.JposException - If an error occurs.
    • trainingMode

      public void trainingMode(boolean flag) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      trainingMode in interface CATInterface
      Parameters:
      flag - TrainingMode for subsequent storing data into journal.
      Throws:
      jpos.JposException - If an error occurs.
    • accessDailyLog

      public AccessDailyLog accessDailyLog(int sequenceNumber, int type, int timeout) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      accessDailyLog in interface CATInterface
      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

      public void accessDailyLog(AccessDailyLog request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      accessDailyLog in interface CATInterface
      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

      public AuthorizeCompletion authorizeCompletion(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizeCompletion in interface CATInterface
      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

      public void authorizeCompletion(AuthorizeCompletion request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizeCompletion in interface CATInterface
      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

      public AuthorizePreSales authorizePreSales(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizePreSales in interface CATInterface
      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

      public void authorizePreSales(AuthorizePreSales request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizePreSales in interface CATInterface
      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

      public AuthorizeRefund authorizeRefund(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizeRefund in interface CATInterface
      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

      public void authorizeRefund(AuthorizeRefund request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizeRefund in interface CATInterface
      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

      public AuthorizeSales authorizeSales(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizeSales in interface CATInterface
      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

      public void authorizeSales(AuthorizeSales request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizeSales in interface CATInterface
      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

      public AuthorizeVoid authorizeVoid(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizeVoid in interface CATInterface
      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

      public void authorizeVoid(AuthorizeVoid request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizeVoid in interface CATInterface
      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

      public AuthorizeVoidPreSales authorizeVoidPreSales(int sequenceNumber, long amount, long taxOthers, int timeout) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizeVoidPreSales in interface CATInterface
      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

      public void authorizeVoidPreSales(AuthorizeVoidPreSales request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      authorizeVoidPreSales in interface CATInterface
      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

      public CashDeposit cashDeposit(int sequenceNumber, long amount, int timeout) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      cashDeposit in interface CATInterface
      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

      public void cashDeposit(CashDeposit request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      cashDeposit in interface CATInterface
      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

      public CheckCard checkCard(int sequenceNumber, int timeout) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      checkCard in interface CATInterface
      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

      public void checkCard(CheckCard request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      checkCard in interface CATInterface
      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

      public LockTerminal lockTerminal() throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      lockTerminal in interface CATInterface
      Returns:
      LockTerminal object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.
    • lockTerminal

      public void lockTerminal(LockTerminal request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      lockTerminal in interface CATInterface
      Parameters:
      request - Output request object returned by validation method to be used by LockTerminal.
      Throws:
      jpos.JposException - If an error occurs.
    • unlockTerminal

      public UnlockTerminal unlockTerminal() throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      unlockTerminal in interface CATInterface
      Returns:
      UnlockTerminal object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.
    • unlockTerminal

      public void unlockTerminal(UnlockTerminal request) throws jpos.JposException
      Description copied from interface: CATInterface
      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.
      Specified by:
      unlockTerminal in interface CATInterface
      Parameters:
      request - Output request object returned by validation method to be used by UnlockTerminal.
      Throws:
      jpos.JposException - If an error occurs.