Package de.gmxhome.conrad.jpos.jpos_base.electronicvaluerw

Interface ElectronicValueRWInterface

All Superinterfaces:
JposBaseInterface
All Known Implementing Classes:
ElectronicValueRWProperties
public interface ElectronicValueRWInterface extends JposBaseInterface
Interface for methods that implement property setter and method calls for the ElectronicValueRW device category. For details about properties, methods and method parameters, see UPOS specification, chapter Electronic Value Reader / Writer. 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 - New value for AdditionalSecurityInformation property..
      Throws:
      jpos.JposException - If an error occurs.

    • amount

      void amount​(long amount) throws jpos.JposException
      Final part of setting Amount. 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,
      • internal property AllowAlwaysSetProperties is true or amount equals the previous value of Amount.
      Parameters:
      amount - Payment amount for electronic money operation.
      Throws:
      jpos.JposException - If an error occurs.

    • approvalCode

      void approvalCode​(String code) throws jpos.JposException
      Final part of setting ApprovalCode. 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 not null,
      • internal property AllowAlwaysSetProperties is true or code equals the previous value of ApprovalCode.
      Parameters:
      code - New value for ApprovalCode property..
      Throws:
      jpos.JposException - If an error occurs.

    • currentService

      void currentService​(String service) throws jpos.JposException
      Final part of setting CurrentService. 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,
      • service is one of the services specified in property ReaderWriterServiceList or an empty string,
      • internal property AllowAlwaysSetProperties is true or service equals the previous value of CurrentService.
      Parameters:
      service - New service specifier.
      Throws:
      jpos.JposException - If an error occurs.

    • detectionControl

      void detectionControl​(boolean flag) throws jpos.JposException
      Final part of setting DetectionControl. 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,
      • CDC_APPLICATIONCONTROL is set in CapDetectionControl or flag is false,
      • internal property AllowAlwaysSetProperties is true or flag equals the previous value of DetectionControl.
      Parameters:
      flag - New value for DetectionControl property..
      Throws:
      jpos.JposException - If an error occurs.

    • mediumID

      void mediumID​(String id) throws jpos.JposException
      Final part of setting MediumID. 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,
      • id is not null,
      • internal property AllowAlwaysSetProperties is true or id equals the previous value of MediumID.
      Parameters:
      id - New value for MediumID property..
      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 CAT service operations.
      Throws:
      jpos.JposException - If an error occurs.

    • PINEntry

      void PINEntry​(int value) throws jpos.JposException
      Final part of setting PINEntry. 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,
      • value is one of PIN_ENTRY_NONE, PIN_ENTRY_EXTERNAL, PIN_ENTRY_INTERNAL or PIN_ENTRY_UNKNOWN,
      • internal property AllowAlwaysSetProperties is true or value equals the previous value of PINEntry.
      Parameters:
      value - New value for PINEntry property.
      Throws:
      jpos.JposException - If an error occurs.

    • point

      void point​(long count) throws jpos.JposException
      Final part of setting Point. 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,
      • internal property AllowAlwaysSetProperties is true or count equals the previous value of Point.
      Parameters:
      count - New value for Point property.
      Throws:
      jpos.JposException - If an error occurs.

    • trainingModeState

      void trainingModeState​(int state) throws jpos.JposException
      Final part of setting TrainingModeState. 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 state is not TM_TRUE,
      • state is one of TM_FALSE, TM_TRUE or TM_UNKNOWN,
      • internal property AllowAlwaysSetProperties is true or state equals the previous value of TrainingModeState.
      Parameters:
      state - TrainingModeState for subsequent operation.
      Throws:
      jpos.JposException - If an error occurs.

    • voucherID

      void voucherID​(String id) throws jpos.JposException
      Final part of setting VoucherID. 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,
      • id is not null.
      • id id has the form "ttt:cc", where ttt is a voucher/ticket identifier and cc the corresponding count > 0,
      • internal property AllowAlwaysSetProperties is true or id equals the previous value of VoucherID.
      Parameters:
      id - New value for VoucherID property..
      Throws:
      jpos.JposException - If an error occurs.

    • voucherIDList

      void voucherIDList​(String ids) throws jpos.JposException
      Final part of setting VoucherIDList. 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,
      • id is not null,
      • id id has the form "ttt1:cc1[,ttt2:cc2[,...]]", where ttt1 and tt2 are voucher/ticket identifiers, cc1 and cc2 the corresponding counts, where ttt2:cc2 is optional as well as further identifier:count pairs, represented by "...".
      • internal property AllowAlwaysSetProperties is true or ids equals the previous value of VoucherIDList.
      Parameters:
      ids - New value for VoucherIDList property..
      Throws:
      jpos.JposException - If an error occurs.

    • beginDetection

      void beginDetection​(int type, int timeout) throws jpos.JposException
      final part of BeginDetection method. 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,
      • State is S_IDLE,
      • DetectionControl is true,
      • type is one of BD_ANY or BD_SPECIFIC,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      type - BD_ANY or BD_SPECIFIC.
      timeout - operation timeout.
      Throws:
      jpos.JposException - If an error occurs.

    • beginRemoval

      void beginRemoval​(int timeout) throws jpos.JposException
      final part of BeginRemoval method. 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,
      • State is S_IDLE,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      timeout - operation timeout.
      Throws:
      jpos.JposException - If an error occurs.

    • captureCard

      void captureCard() throws jpos.JposException
      final part of CaptureCard method. 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,
      Throws:
      jpos.JposException - If an error occurs.

    • clearParameterInformation

      void clearParameterInformation() throws jpos.JposException
      final part of ClearParameterInformation method. 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.
      Throws:
      jpos.JposException - If an error occurs.

    • endDetection

      void endDetection() throws jpos.JposException
      final part of ClearParameterInformation method. 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,
      • DetectionControl is true.
      Throws:
      jpos.JposException - If an error occurs.

    • endRemoval

      void endRemoval() throws jpos.JposException
      final part of ClearParameterInformation method. 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,
      • DetectionControl is true.
      Throws:
      jpos.JposException - If an error occurs.

    • enumerateCardServices

      void enumerateCardServices() throws jpos.JposException
      final part of EnumerateCardServices method. 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.
      Throws:
      jpos.JposException - If an error occurs.

    • retrieveResultInformation

      void retrieveResultInformation​(String name, String[] value) throws jpos.JposException
      final part of RetrieveResultInformation method. 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 claimed,
      • name is not null and value is an array with dimension 1.
      Currency values will be returned as decimal string with decimal dot, where trailing zeros up to and inclusive the decimal dot may be truncated. For example, a value of 123.45 can be returned as "123.45" or "123.4500", 100.00 can be returned as "100", "100.00" or "100.0000". Even if a value of 123.45 will be stored as 1234500 within a variable of type long, it will not be returned as "1234500".
      Parameters:
      name - Tag name
      value - Array to be filled with tag value on return.
      Throws:
      jpos.JposException - If an error occurs.

    • setParameterInformation

      void setParameterInformation​(String name, String value) throws jpos.JposException
      final part of SetParameterInformation method. Can be overwritten within derived classes, if necessary.
      • Device is claimed,
      • name and value are not null,
      Remarks:
      • Since the UPOS specification for tag VoidTransactionType and VOIDorRETURN is unclear, only numerical values "1" and "2" are supported for these tags.
      • Tag SettledVoucherID will be handled the same way as tag SetttledVoucherID.
      • In case of a Date tag, parsing value is successful.
      • Currency values passed in value must be passed as decimal string with decimal dot, where trailing zeros up to and inclusive the decimal dot may be truncated. For example, a value of 123.45 can be returned as "123.45" or "123.4500", 100.00 can be returned as "100", "100.00" or "100.0000". Even if a value of 123.45 will be stored as 1234500 within a variable of type long, it must not be passed as "1234500".
      • In case of Enumerated tag values, only the values specified in the UPOS specification must be passed in value.
      If value is an empty string, the parameter information will be deleted.
      Parameters:
      name - Tag name
      value - Array to be filled with tag value on return.
      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,
      • CapDailyLog is true,
      • State is S_IDLE,
      • 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 AccessData method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a AccessData 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 AccessData.
      Throws:
      jpos.JposException - If an error occurs.

    • accessData

      AccessData accessData​(int dataType, int[] data, Object[] obj) throws jpos.JposException
      Validation part of AccessData 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,
      • State is S_IDLE,
      • dataType is one of AD_KEY, AD_NEGATIVE_LIST or AD_OTHERS,
      • data and type are non-null arrays with dimension 1.
      Parameters:
      dataType - Data type.
      data - vendor specific data.
      obj - vendor specific Object.
      Returns:
      AccessData object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • accessData

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

    • accessLog

      AccessLog accessLog​(int sequenceNumber, int type, int timeout) throws jpos.JposException
      Validation part of AccessLog 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,
      • State is S_IDLE,
      • type is one of AL_REPORTING or AL_SETTLEMENT and is contained in CapDailyLog,
      • timeout is JPOS_FOREVER or ≥ 0.
      Parameters:
      sequenceNumber - Sequence number, any value.
      type - AL_REPORTING or AL_SETTLEMENT.
      timeout - operation timeout.
      Returns:
      AccessLog object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • accessLog

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

    • activateEVService

      ActivateEVService activateEVService​(int[] data, Object[] obj) throws jpos.JposException
      Validation part of ActivateEVService 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,
      • State is S_IDLE,
      • data and obj are arrays with dimension 0 or 1.
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      ActivateEVService object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • activateEVService

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

    • activateService

      ActivateService activateService​(int[] data, Object[] obj) throws jpos.JposException
      Validation part of ActivateService 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,
      • State is S_IDLE,
      • CapActivateService is true,
      • data and obj are arrays with dimension 0 or 1.
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      ActivateService object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • activateService

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

    • addValue

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

    • addValue

      void addValue​(AddValue request) throws jpos.JposException
      Final part of AddValue method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a AddValue 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 AddValue.
      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,
      • State is S_IDLE,
      • 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,
      • State is S_IDLE,
      • 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,
      • State is S_IDLE,
      • 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,
      • State is S_IDLE,
      • 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,
      • State is S_IDLE,
      • 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,
      • State is S_IDLE,
      • 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.

    • cancelValue

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

    • cancelValue

      void cancelValue​(CancelValue request) throws jpos.JposException
      Final part of CancelValue method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a CancelValue 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 CancelValue.
      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,
      • State is S_IDLE,
      • 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,
      • State is S_IDLE,
      • 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.

    • checkServiceRegistrationToMedium

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

    • checkServiceRegistrationToMedium

      void checkServiceRegistrationToMedium​(CheckServiceRegistrationToMedium request) throws jpos.JposException
      Final part of CheckServiceRegistrationToMedium 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 CheckServiceRegistrationToMedium.
      Throws:
      jpos.JposException - If an error occurs.

    • closeDailyEVService

      CloseDailyEVService closeDailyEVService​(int[] data, Object[] obj) throws jpos.JposException
      Validation part of CloseDailyEVService 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,
      • State is S_IDLE,
      • data and obj are arrays with dimension 0 or 1.
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      CloseDailyEVService object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • closeDailyEVService

      void closeDailyEVService​(CloseDailyEVService request) throws jpos.JposException
      Final part of CloseDailyEVService 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 CloseDailyEVService.
      Throws:
      jpos.JposException - If an error occurs.

    • deactivateEVService

      DeactivateEVService deactivateEVService​(int[] data, Object[] obj) throws jpos.JposException
      Validation part of DeactivateEVService 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,
      • State is S_IDLE,
      • data and obj are arrays with dimension 0 or 1.
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      DeactivateEVService object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • deactivateEVService

      void deactivateEVService​(DeactivateEVService request) throws jpos.JposException
      Final part of DeactivateEVService 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 DeactivateEVService.
      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,
      • State is S_IDLE,
      • CapLockTerminal is true.
      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.

    • openDailyEVService

      OpenDailyEVService openDailyEVService​(int[] data, Object[] obj) throws jpos.JposException
      Validation part of OpenDailyEVService 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,
      • State is S_IDLE,
      • data and obj are arrays with dimension 0 or 1.
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      OpenDailyEVService object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • openDailyEVService

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

    • queryLastSuccessfulTransactionResult

      QueryLastSuccessfulTransactionResult queryLastSuccessfulTransactionResult() throws jpos.JposException
      Validation part of QueryLastSuccessfulTransactionResult 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.
      Returns:
      QueryLastSuccessfulTransactionResult object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • queryLastSuccessfulTransactionResult

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

    • readValue

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

    • readValue

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

    • registerServiceToMedium

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

    • registerServiceToMedium

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

    • subtractValue

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

    • subtractValue

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

    • transactionAccess

      TransactionAccess transactionAccess​(int control) throws jpos.JposException
      Validation part of TransactionAccess 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,
      • State is S_IDLE,
      • CapTransaction is true,
      • control is one of TA_TRANSACTION or TA_NORMAL,
      • Either a transaction has not been started or control is TA_NORMAL.
      Parameters:
      control - The transaction control.
      Returns:
      TransactionAccess object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • transactionAccess

      void transactionAccess​(TransactionAccess request) throws jpos.JposException
      Final part of TransactionAccess method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a TransactionAccess 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 TransactionAccess.
      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,
      • State is S_IDLE,
      • 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.

    • unregisterServiceToMedium

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

    • unregisterServiceToMedium

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

    • updateData

      UpdateData updateData​(int dataType, int[] data, Object[] obj) throws jpos.JposException
      Validation part of UpdateData 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,
      • State is S_IDLE,
      • dataType is one of AD_KEY, AD_NEGATIVE_LIST or AD_OTHERS,
      • data and obj are arrays with dimension 0 or 1.
      Parameters:
      dataType - Type of data.
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      UpdateData object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • updateData

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

    • updateKey

      UpdateKey updateKey​(int[] data, Object[] obj) throws jpos.JposException
      Validation part of UpdateKey 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,
      • State is S_IDLE,
      • data and obj are arrays with dimension 0 or 1.
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      UpdateKey object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.

    • updateKey

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

    • writeValue

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

    • writeValue

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