com.ibm.commerce.payments.plugincontroller

Class FinancialTransaction

  • java.lang.Object
    • com.ibm.commerce.payments.plugincontroller.FinancialTransaction
  • All Implemented Interfaces:
    java.io.Serializable


    public class FinancialTransaction
    extends java.lang.Object
    implements java.io.Serializable
    This class represents the value object of the Financial Transaction object.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static short APPROVE_TRAN_TYPE
      The short value represents the transaction type - approve.
      static short APPROVEANDDEPOSIT_TRAN_TYPE
      The short value represents the transaction type - approveAndDeposit.
      static short CANCELED_STATE
      The short value represents the state = canceled.
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static short CREDIT_TRAN_TYPE
      The short value represents the transaction type - credit.
      static short DEPOSIT_TRAN_TYPE
      The short value represents the transaction type - deposit.
      static short FAILED_STATE
      The short value represents the state = failed.
      static short NEW_STATE
      The short value represents the state = new.
      static short PENDING_STATE
      The short value represents the state = pending.
      static short RESERVE_APPPROVE_TRAN_TYPE
      The short value represents the transaction type - reverseApprove.
      static short RESERVE_CREDIT_TRAN_TYPE
      The short value represents the transaction type - reverseCredit.
      static short RESERVE_DEPOSIT_TRAN_TYPE
      The short value represents the transaction type - reverseDeposit.
      static short SUCCESS_STATE
      The short value represents the state = success.
    • Constructor Summary

      Constructors 
      Constructor and Description
      FinancialTransaction(java.lang.String idLocal, Credit creditLocal)
      This method is the constructor of this class with id and credit.
      FinancialTransaction(java.lang.String idLocal, Payment paymentLocal)
      This method is the constructor of this class with id and payment.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      Credit getCredit()
      This method returns the credit object associated current financial transaction.
      java.util.HashMap getExtendedData()
      This method returns the extended data of this financial transaction.
      java.lang.String getId()
      This method returns the identifier of current financial transaction.
      Payment getPayment()
      This method returns the payment object associated with current financial transaction.
      java.math.BigDecimal getProcessedAmount()
      This method returns the processed amount by the backend financial system of current financial transaction.
      java.lang.String getReasonCode()
      This method returns the reason code for the response code received from the backend financial system.
      java.lang.String getReferenceNumber()
      This method returns the reference number received from the backend financial system, it could be used later in the subsequent transactions.
      java.math.BigDecimal getRequestedAmount()
      This method returns the requested amount to be processed by this financial transaction.
      java.lang.String getResponseCode()
      This method returns the response code received from the backend financial system
      short getState()
      This method returns the state of current financial transaction.
      long getTimeCreated()
      This method returns the time when the financial transaction was created.
      long getTimeUpdated()
      This method returns the time when the financial transaction was updated.
      java.lang.String getTrackingId()
      This method returns the identifier generated by the plug-in for this financial transaction.
      short getTransactionType()
      This method returns the transaction type of current financial transaction.
      void setCredit(Credit creditLocal)
      This method sets the credit object associated current financial transaction.
      void setExtendedData(java.util.HashMap extendedDataLocal)
      This method sets the extended data of this financial transaction.
      void setId(java.lang.String idLocal)
      This method sets the identifier of current financial transaction.
      void setPayment(Payment paymentLocal)
      This method sets the payment object associated with current financial transaction.
      void setProcessedAmount(java.math.BigDecimal amount)
      This method sets the processed amount by the backend financial system of current financial transaction.
      void setReasonCode(java.lang.String code)
      This method sets the reason code for the response code received from the backend financial system
      void setReferenceNumber(java.lang.String number)
      This method sets the reference number received from the backend financial system, it could be used later in the subsequent transactions.
      void setRequestedAmount(java.math.BigDecimal amount)
      This method sets the requested amount to be processed by this financial transaction
      void setResponseCode(java.lang.String code)
      This method sets the response code received from the backend financial system
      void setState(short stateLocal)
      This method sets the state of current financial transaction.
      void setTimeCreated(long created)
      This method sets the time when the financial transaction was created.
      void setTimeUpdated(long updated)
      This method sets the time when the financial transaction was update.
      void setTrackingId(java.lang.String idLocal)
      This method sets the identifier generated by the plug-in for this financial transaction.
      void setTransactionType(short type)
      This method sets the transaction type of current financial transaction.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • APPROVE_TRAN_TYPE

        public static final short APPROVE_TRAN_TYPE
        The short value represents the transaction type - approve.
        See Also:
        Constant Field Values
      • DEPOSIT_TRAN_TYPE

        public static final short DEPOSIT_TRAN_TYPE
        The short value represents the transaction type - deposit.
        See Also:
        Constant Field Values
      • APPROVEANDDEPOSIT_TRAN_TYPE

        public static final short APPROVEANDDEPOSIT_TRAN_TYPE
        The short value represents the transaction type - approveAndDeposit.
        See Also:
        Constant Field Values
      • CREDIT_TRAN_TYPE

        public static final short CREDIT_TRAN_TYPE
        The short value represents the transaction type - credit.
        See Also:
        Constant Field Values
      • RESERVE_APPPROVE_TRAN_TYPE

        public static final short RESERVE_APPPROVE_TRAN_TYPE
        The short value represents the transaction type - reverseApprove.
        See Also:
        Constant Field Values
      • RESERVE_DEPOSIT_TRAN_TYPE

        public static final short RESERVE_DEPOSIT_TRAN_TYPE
        The short value represents the transaction type - reverseDeposit.
        See Also:
        Constant Field Values
      • RESERVE_CREDIT_TRAN_TYPE

        public static final short RESERVE_CREDIT_TRAN_TYPE
        The short value represents the transaction type - reverseCredit.
        See Also:
        Constant Field Values
      • NEW_STATE

        public static final short NEW_STATE
        The short value represents the state = new.
        See Also:
        Constant Field Values
      • PENDING_STATE

        public static final short PENDING_STATE
        The short value represents the state = pending.
        See Also:
        Constant Field Values
      • SUCCESS_STATE

        public static final short SUCCESS_STATE
        The short value represents the state = success.
        See Also:
        Constant Field Values
      • FAILED_STATE

        public static final short FAILED_STATE
        The short value represents the state = failed.
        See Also:
        Constant Field Values
      • CANCELED_STATE

        public static final short CANCELED_STATE
        The short value represents the state = canceled.
        See Also:
        Constant Field Values
    • Constructor Detail

      • FinancialTransaction

        public FinancialTransaction(java.lang.String idLocal,
                                    Payment paymentLocal)
        This method is the constructor of this class with id and payment.
        Parameters:
        idLocal - the identifier of this FinancialTransaction object
        paymentLocal - the Payment value object
      • FinancialTransaction

        public FinancialTransaction(java.lang.String idLocal,
                                    Credit creditLocal)
        This method is the constructor of this class with id and credit.
        Parameters:
        idLocal - the identifier of this FinancialTransaction object
        creditLocal - the Credit value object
    • Method Detail

      • getState

        public short getState()
        This method returns the state of current financial transaction.
        Returns:
        the state of current financial transaction
      • setState

        public void setState(short stateLocal)
        This method sets the state of current financial transaction.
        Parameters:
        stateLocal - the state of current financial transaction
      • getTransactionType

        public short getTransactionType()
        This method returns the transaction type of current financial transaction.
        Returns:
        the transaction type of current financial transaction
      • setTransactionType

        public void setTransactionType(short type)
        This method sets the transaction type of current financial transaction.
        Parameters:
        type - the transaction type of current financial transaction
      • getCredit

        public Credit getCredit()
        This method returns the credit object associated current financial transaction.
        Returns:
        the credit object associated current financial transaction
      • setCredit

        public void setCredit(Credit creditLocal)
        This method sets the credit object associated current financial transaction.
        Parameters:
        creditLocal - the credit object associated current financial transaction to set
      • getId

        public java.lang.String getId()
        This method returns the identifier of current financial transaction.
        Returns:
        the identifier of current financial transaction
      • setId

        public void setId(java.lang.String idLocal)
        This method sets the identifier of current financial transaction.
        Parameters:
        idLocal - the identifier of current financial transaction to set
      • getPayment

        public Payment getPayment()
        This method returns the payment object associated with current financial transaction.
        Returns:
        the payment object associated with current financial transaction
      • setPayment

        public void setPayment(Payment paymentLocal)
        This method sets the payment object associated with current financial transaction.
        Parameters:
        paymentLocal - the payment object associated with current financial transaction
      • getProcessedAmount

        public java.math.BigDecimal getProcessedAmount()
        This method returns the processed amount by the backend financial system of current financial transaction.
        Returns:
        the processed amount by the backend financial system of current financial transaction
      • setProcessedAmount

        public void setProcessedAmount(java.math.BigDecimal amount)
        This method sets the processed amount by the backend financial system of current financial transaction.
        Parameters:
        amount - the processed amount by the backend financial system of current financial transaction
      • getReasonCode

        public java.lang.String getReasonCode()
        This method returns the reason code for the response code received from the backend financial system.
        Returns:
        the reason code for the response code received from the backend financial system
      • setReasonCode

        public void setReasonCode(java.lang.String code)
        This method sets the reason code for the response code received from the backend financial system
        Parameters:
        code - the reason code for the response code received from the backend financial system
      • getReferenceNumber

        public java.lang.String getReferenceNumber()
        This method returns the reference number received from the backend financial system, it could be used later in the subsequent transactions.
        Returns:
        the reference number received from the backend financial system, it could be used later in the subsequent transactions.
      • setReferenceNumber

        public void setReferenceNumber(java.lang.String number)
        This method sets the reference number received from the backend financial system, it could be used later in the subsequent transactions.
        Parameters:
        number - the reference number received from the backend financial system, it could be used later in the subsequent transactions.
      • getRequestedAmount

        public java.math.BigDecimal getRequestedAmount()
        This method returns the requested amount to be processed by this financial transaction.
        Returns:
        the requested amount to be processed by this financial transaction
      • setRequestedAmount

        public void setRequestedAmount(java.math.BigDecimal amount)
        This method sets the requested amount to be processed by this financial transaction
        Parameters:
        amount - the requested amount to be processed by this financial transaction
      • getResponseCode

        public java.lang.String getResponseCode()
        This method returns the response code received from the backend financial system
        Returns:
        the response code received from the backend financial system
      • setResponseCode

        public void setResponseCode(java.lang.String code)
        This method sets the response code received from the backend financial system
        Parameters:
        code - the response code received from the backend financial system
      • getTimeCreated

        public long getTimeCreated()
        This method returns the time when the financial transaction was created.
        Returns:
        the time when the financial transaction was created
      • setTimeCreated

        public void setTimeCreated(long created)
        This method sets the time when the financial transaction was created.
        Parameters:
        created - the time when the financial transaction was created
      • getTimeUpdated

        public long getTimeUpdated()
        This method returns the time when the financial transaction was updated.
        Returns:
        the time when the financial transaction was updated
      • setTimeUpdated

        public void setTimeUpdated(long updated)
        This method sets the time when the financial transaction was update.
        Parameters:
        updated - the time when the financial transaction was updated
      • getTrackingId

        public java.lang.String getTrackingId()
        This method returns the identifier generated by the plug-in for this financial transaction. Plug-in will generate this value on behalf of the merchant for tracking purpose.
        Returns:
        the identifier generated by the plug-in for this financial transaction
      • setTrackingId

        public void setTrackingId(java.lang.String idLocal)
        This method sets the identifier generated by the plug-in for this financial transaction. Plug-in will generate this value on behalf of the merchant for tracking purpose.
        Parameters:
        idLocal - the identifier generated by the plug-in for this financial transaction
      • getExtendedData

        public java.util.HashMap getExtendedData()
        This method returns the extended data of this financial transaction.
        Returns:
        the extended data of this financial transaction
      • setExtendedData

        public void setExtendedData(java.util.HashMap extendedDataLocal)
        This method sets the extended data of this financial transaction.
        Parameters:
        extendedDataLocal - the extended data of this financial transaction