Class ElectronicValueRWProperties

java.lang.Object
de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties
de.gmxhome.conrad.jpos.jpos_base.electronicvaluerw.ElectronicValueRWProperties
All Implemented Interfaces:
ElectronicValueRWInterface, JposBaseInterface

public class ElectronicValueRWProperties extends JposCommonProperties implements ElectronicValueRWInterface
Class containing the electronic value reader / writer specific properties, their default values and default implementations of ElectronicValueRWInterface. For details about properties, methods and method parameters, see UPOS specification, chapter Electronic Value Reader / Writer.
  • Field Details

    • AccountNumber

      public String AccountNumber
      UPOS property AccountNumber.
    • AdditionalSecurityInformation

      public String AdditionalSecurityInformation
      UPOS property AdditionalSecurityInformation.
    • Amount

      public long Amount
      UPOS property Amount.
    • ApprovalCode

      public String ApprovalCode
      UPOS property ApprovalCode.
    • Balance

      public long Balance
      UPOS property Balance.
    • BalanceOfPoint

      public long BalanceOfPoint
      UPOS property BalanceOfPoint.
    • CapActivateService

      public boolean CapActivateService
      UPOS property CapActivateService. Default: false. 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.
    • CapAddValue

      public boolean CapAddValue
      UPOS property CapAddValue. Default: false. 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.
    • CapCancelValue

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

      public int CapCardSensor
      UPOS property CapCardSensor. Default: 0. 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.
    • CapDetectionControl

      public int CapDetectionControl
      UPOS property CapDetectionControl. Default: CDC_RWCONTROL. Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • CapElectronicMoney

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

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

      public boolean CapIndirectTransactionLog
      UPOS property CapIndirectTransactionLog. Default: false. 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.
    • CapMediumID

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

      public boolean CapMembershipCertificate
      UPOS property CapMembershipCertificate. 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.
    • CapPINDevice

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

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

      public boolean CapSubtractValue
      UPOS property CapSubtractValue. 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.
    • CapTransaction

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

      public boolean CapTransactionLog
      UPOS property CapTransactionLog. 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.
    • CapUpdateKey

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

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

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

      public String CardCompanyID
      UPOS property CardCompanyID.
    • CardServiceList

      public String CardServiceList
      UPOS property CardServiceList.
    • CenterResultCode

      public String CenterResultCode
      UPOS property CenterResultCode.
    • CurrentService

      public String CurrentService
      UPOS property CurrentService.
    • DailyLog

      public String DailyLog
      UPOS property DailyLog.
    • DetectionControl

      public boolean DetectionControl
      UPOS property DetectionControl.
    • DetectionStatus

      public int DetectionStatus
      UPOS property DetectionStatus.
    • ExpirationDate

      public String ExpirationDate
      UPOS property ExpirationDate.
    • LastUsedDate

      public String LastUsedDate
      UPOS property LastUsedDate.
    • LogStatus

      public Integer LogStatus
      UPOS property LogStatus. Default: null. Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • MediumID

      public String MediumID
      UPOS property MediumID.
    • PaymentCondition

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

      public String PaymentDetail
      UPOS property PaymentDetail. Default: null. Can be overwritten by objects derived from JposDevice within the changeDefaults method.
    • PaymentMedia

      public int PaymentMedia
      UPOS property PaymentMedia.
    • PINEntry

      public int PINEntry
      UPOS property PINEntry.
    • Point

      public long Point
      UPOS property Point.
    • ReaderWriterServiceList

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

      public int SequenceNumber
      UPOS property SequenceNumber.
    • ServiceType

      public int ServiceType
      UPOS property ServiceType.
    • SettledAmount

      public long SettledAmount
      UPOS property SettledAmount.
    • SettledPoint

      public long SettledPoint
      UPOS property SettledPoint.
    • SlipNumber

      public String SlipNumber
      UPOS property SlipNumber.
    • TrainingModeState

      public int TrainingModeState
      UPOS property TrainingModeState.
    • TransactionLog

      public String TransactionLog
      UPOS property TransactionLog.
    • TransactionNumber

      public String TransactionNumber
      UPOS property TransactionNumber.
    • TransactionType

      public int TransactionType
      UPOS property TransactionType.
    • VoucherID

      public String VoucherID
      UPOS property VoucherID.
    • VoucherIDList

      public String VoucherIDList
      UPOS property VoucherIDList.
    • Parameters

      @Deprecated public Map<String,​String> Parameters
      Deprecated.
      Tag names and values set by setParameterInformation. Will be initialized to an empty Map during claim and by invocation of method clearParameterInformation. Deprecated because replaced by TypedParameters.
    • TypedParameters

      public TypeSafeStringMap TypedParameters
      Tag names and values set by setParameterInformation. Will be initialized to an empty Map during claim and by invocation of method clearParameterInformation.
    • Results

      @Deprecated public Map<String,​String> Results
      Deprecated.
      Tag names and values hold for method retrieveResultInformation. Must be initialized to an empty Map whenever the service has read a new card. Automatic initialized to an empty Map by this framework will occur during successful claim and endDetection. This implies that initialization by the service is not necessary during the first card reading after claim and whenever the card detection process has been controlled by methods beginDetection and endDetection.
    • TypedResults

      public TypeSafeStringMap TypedResults
      Tag names and values hold for method retrieveResultInformation. Must be initialized to an empty Map whenever the service has read a new card. Automatic initialized to an empty Map by this framework will occur during successful claim and endDetection. This implies that initialization by the service is not necessary during the first card reading after claim and whenever the card detection process has been controlled by methods beginDetection and endDetection.
    • UseEnumeratedValues

      public boolean UseEnumeratedValues
      Specifies whether enumerated values will be passed by value (true) or by name (false). Default is true.
    • StrongEnumerationCheck

      public boolean StrongEnumerationCheck
      Specifies whether enumeration values will be checked against the list of enumerations specified in the corresponding UPOS specification (true) or not (false). In the latter case, any value can be passes for an enumeration value and the specific service implementation must decide whether the given value shall be supported. Default is true.
  • Constructor Details

    • ElectronicValueRWProperties

      protected ElectronicValueRWProperties(int dev)
      Constructor.
      Parameters:
      dev - Device index
  • Method Details

    • checkProperties

      public void checkProperties(jpos.config.JposEntry entry) throws jpos.JposException
      Description copied from class: JposCommonProperties
      Checks jpos entries for service specific jpos property values and set corresponding service values.
      Overrides:
      checkProperties in class JposCommonProperties
      Parameters:
      entry - JposEntry instance that contains all jpos properties for the device. Only service specific entries are of interest here, device specific entries should be processed by the corresponding checkProperties method of the device implementation derived from JposDevice.
      Throws:
      jpos.JposException - a service related property is invalid or a mandatory service related property is missing.
    • initOnOpen

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

      public void initOnClaim()
      Description copied from class: JposCommonProperties
      Initialize properties that must be initialized whenever the device will be claimed.
      Overrides:
      initOnClaim in class JposCommonProperties
    • checkTagValueFormat

      public jpos.JposException checkTagValueFormat(String tag, String value)
      Method to verify whether the format of a value matches the format specified for the given tag. See the UPOS specification, chapter 15.5.31 retrieveResultInformation Method for the general layout.
      Parameters:
      tag - tag name.
      value - value to be checked.
      Returns:
      JposException if value is invalid for tag, null if format of value matches the specification.
    • additionalSecurityInformation

      public void additionalSecurityInformation(String addInfo) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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 ElectronicValueRWInterface
      Parameters:
      addInfo - New value for AdditionalSecurityInformation property..
      Throws:
      jpos.JposException - If an error occurs.
    • amount

      public void amount(long amount) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      amount in interface ElectronicValueRWInterface
      Parameters:
      amount - Payment amount for electronic money operation.
      Throws:
      jpos.JposException - If an error occurs.
    • approvalCode

      public void approvalCode(String code) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      approvalCode in interface ElectronicValueRWInterface
      Parameters:
      code - New value for ApprovalCode property..
      Throws:
      jpos.JposException - If an error occurs.
    • currentService

      public void currentService(String service) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      currentService in interface ElectronicValueRWInterface
      Parameters:
      service - New service specifier.
      Throws:
      jpos.JposException - If an error occurs.
    • detectionControl

      public void detectionControl(boolean flag) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      detectionControl in interface ElectronicValueRWInterface
      Parameters:
      flag - New value for DetectionControl property..
      Throws:
      jpos.JposException - If an error occurs.
    • mediumID

      public void mediumID(String id) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      mediumID in interface ElectronicValueRWInterface
      Parameters:
      id - New value for MediumID property..
      Throws:
      jpos.JposException - If an error occurs.
    • paymentMedia

      public void paymentMedia(int media) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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 ElectronicValueRWInterface
      Parameters:
      media - PaymentMedia for subsequent CAT service operations.
      Throws:
      jpos.JposException - If an error occurs.
    • PINEntry

      public void PINEntry(int value) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      PINEntry in interface ElectronicValueRWInterface
      Parameters:
      value - New value for PINEntry property.
      Throws:
      jpos.JposException - If an error occurs.
    • point

      public void point(long count) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      point in interface ElectronicValueRWInterface
      Parameters:
      count - New value for Point property.
      Throws:
      jpos.JposException - If an error occurs.
    • trainingModeState

      public void trainingModeState(int state) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      trainingModeState in interface ElectronicValueRWInterface
      Parameters:
      state - TrainingModeState for subsequent operation.
      Throws:
      jpos.JposException - If an error occurs.
    • voucherID

      public void voucherID(String id) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      voucherID in interface ElectronicValueRWInterface
      Parameters:
      id - New value for VoucherID property..
      Throws:
      jpos.JposException - If an error occurs.
    • voucherIDList

      public void voucherIDList(String ids) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      voucherIDList in interface ElectronicValueRWInterface
      Parameters:
      ids - New value for VoucherIDList property..
      Throws:
      jpos.JposException - If an error occurs.
    • beginDetection

      public void beginDetection(int type, int timeout) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      beginDetection in interface ElectronicValueRWInterface
      Parameters:
      type - BD_ANY or BD_SPECIFIC.
      timeout - operation timeout.
      Throws:
      jpos.JposException - If an error occurs.
    • beginRemoval

      public void beginRemoval(int timeout) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      beginRemoval in interface ElectronicValueRWInterface
      Parameters:
      timeout - operation timeout.
      Throws:
      jpos.JposException - If an error occurs.
    • captureCard

      public void captureCard() throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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,
      Specified by:
      captureCard in interface ElectronicValueRWInterface
      Throws:
      jpos.JposException - If an error occurs.
    • clearParameterInformation

      public void clearParameterInformation() throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      clearParameterInformation in interface ElectronicValueRWInterface
      Throws:
      jpos.JposException - If an error occurs.
    • endDetection

      public void endDetection() throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      endDetection in interface ElectronicValueRWInterface
      Throws:
      jpos.JposException - If an error occurs.
    • endRemoval

      public void endRemoval() throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      endRemoval in interface ElectronicValueRWInterface
      Throws:
      jpos.JposException - If an error occurs.
    • enumerateCardServices

      public void enumerateCardServices() throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      enumerateCardServices in interface ElectronicValueRWInterface
      Throws:
      jpos.JposException - If an error occurs.
    • retrieveResultInformation

      public void retrieveResultInformation(String name, String[] value) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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".
      Specified by:
      retrieveResultInformation in interface ElectronicValueRWInterface
      Parameters:
      name - Tag name
      value - Array to be filled with tag value on return.
      Throws:
      jpos.JposException - If an error occurs.
    • setParameterInformation

      public void setParameterInformation(String name, String value) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      setParameterInformation in interface ElectronicValueRWInterface
      Parameters:
      name - Tag name
      value - Array to be filled with tag value on return.
      Throws:
      jpos.JposException - If an error occurs.
    • getEnumTagFromPropertyValue

      public Integer getEnumTagFromPropertyValue(String name, int value)
      Convert property value into tag value.
      Parameters:
      name - Name of the parameter tag, e.g. "PaymentCondition"
      value - Property value.
      Returns:
      The corresponding tag value, null if no corresponding tag value exists or value is invalid.
    • getPropertyValueFromEnumTag

      @Deprecated public Integer getPropertyValueFromEnumTag(String name, int value)
      Deprecated.
      Convert parameter tag value into corresponding property value.
      Parameters:
      name - Name of the parameter tag, e.g. "PaymentCondition"
      value - Enumerated number.
      Returns:
      The corresponding property value, null if no corresponding property value exists or if tag or value is invalid.
    • getPropertyValueFromEnumTag

      @Deprecated public Integer getPropertyValueFromEnumTag(String name, String valstr)
      Deprecated.
      Convert parameter tag value into corresponding property value. Deprecated.
      Parameters:
      name - Name of the parameter tag, e.g. "PaymentCondition"
      valstr - String representing the corresponding Enumerated number.
      Returns:
      The corresponding property value, null if no corresponding property value exists or if tag or valstr is invalid.
    • accessDailyLog

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

      public AccessData accessData(int dataType, int[] data, Object[] obj) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      accessData in interface ElectronicValueRWInterface
      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

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

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

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

      public ActivateEVService activateEVService(int[] data, Object[] obj) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      activateEVService in interface ElectronicValueRWInterface
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      ActivateEVService object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.
    • activateEVService

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

      public ActivateService activateService(int[] data, Object[] obj) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      activateService in interface ElectronicValueRWInterface
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      ActivateService object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.
    • activateService

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

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

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

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

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

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

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

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

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

      public CloseDailyEVService closeDailyEVService(int[] data, Object[] obj) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      closeDailyEVService in interface ElectronicValueRWInterface
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      CloseDailyEVService object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.
    • closeDailyEVService

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

      public DeactivateEVService deactivateEVService(int[] data, Object[] obj) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      deactivateEVService in interface ElectronicValueRWInterface
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      DeactivateEVService object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.
    • deactivateEVService

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

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

      public OpenDailyEVService openDailyEVService(int[] data, Object[] obj) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      openDailyEVService in interface ElectronicValueRWInterface
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      OpenDailyEVService object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.
    • openDailyEVService

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

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

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

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

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

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

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

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

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

      public TransactionAccess transactionAccess(int control) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      transactionAccess in interface ElectronicValueRWInterface
      Parameters:
      control - The transaction control.
      Returns:
      TransactionAccess object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.
    • transactionAccess

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

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

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

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

      public UpdateData updateData(int dataType, int[] data, Object[] obj) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      updateData in interface ElectronicValueRWInterface
      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

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

      public UpdateKey updateKey(int[] data, Object[] obj) throws jpos.JposException
      Description copied from interface: ElectronicValueRWInterface
      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.
      Specified by:
      updateKey in interface ElectronicValueRWInterface
      Parameters:
      data - Vendor specific.
      obj - vendor specific.
      Returns:
      UpdateKey object for use in final part.
      Throws:
      jpos.JposException - If an error occurs.
    • updateKey

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

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

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