Package com.broadleafcommerce.paymenttransaction.domain

Class PaymentTransactionResultAudit

java.lang.Object
com.broadleafcommerce.paymenttransaction.domain.PaymentTransactionResultAudit
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
public class PaymentTransactionResultAudit extends Object implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware
Since:
Payment Transaction Service 2.0.6, Release Train 2.1.4, Release Train 2.2.0
See Also:

  • Constructor Details

    • PaymentTransactionResultAudit

      public PaymentTransactionResultAudit()

  • Method Details

    • getId

      public String getId()
      The id of this payment transaction result audit.
      Returns:
      The id of this payment transaction result audit.

    • getPaymentTransactionId

      public String getPaymentTransactionId()
      A reference to the updated transaction this result belongs to.

    • getDateRecorded

      public Instant getDateRecorded()
      The timestamp when this transaction response was recorded
      Returns:
      The timestamp when this transaction response was recorded

    • getGatewayResponseCode

      public String getGatewayResponseCode()
      The response code provided by the payment gateway which may represent a success or failure
      Returns:
      The response code provided by the payment gateway which may represent a success or failure

    • getFailureType

      public String getFailureType()
      The type of transaction failure
      Returns:
      The type of transaction failure

    • getDeclineType

      public String getDeclineType()
      The type of transaction failure (hard vs soft failure)
      Returns:
      The type of transaction failure (hard vs soft failure)

    • getStatus

      public String getStatus()
      The status of the transaction at the time this result was received
      Returns:
      The status of the transaction at the time this result was received
      See Also:

    • getGatewayMessage

      public String getGatewayMessage()
      Message from the gateway describing the result of the transaction.
      Returns:
      Message from the gateway describing the result of the transaction.

    • getRawResponse

      public String getRawResponse()
      The string representation of the serialized response from the gateway. This is usually the complete request parameter map serialized in string form.
      Returns:
      The string representation of the serialized response from the gateway

    • getRequestId

      public String getRequestId()
      The id used to represent the request that produced this transaction result.
      Returns:
      The id used to represent the request that produced this transaction result

    • getAttributes

      public Map<String,Object> getAttributes()
      Map of specific attributes that have been gathered from the raw response. This should be used for data points that are to be used programmatically.
      Returns:
      Map of specific fields that have been gathered from the raw response

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Returns:
      a subset of Tracking information to expose the context state for this object

    • setId

      public void setId(String id)
      The id of this payment transaction result audit.
      Parameters:
      paymentTransactionId - The id of this payment transaction result audit.

    • setPaymentTransactionId

      public void setPaymentTransactionId(String paymentTransactionId)
      A reference to the updated transaction this result belongs to.

    • setDateRecorded

      public void setDateRecorded(Instant dateRecorded)
      The timestamp when this transaction response was recorded
      Parameters:
      dateRecorded - The timestamp when this transaction response was recorded

    • setGatewayResponseCode

      public void setGatewayResponseCode(String gatewayResponseCode)
      The response code provided by the payment gateway which may represent a success or failure
      Parameters:
      gatewayResponseCode - The response code provided by the payment gateway which may represent a success or failure

    • setFailureType

      public void setFailureType(String failureType)
      The type of transaction failure
      Parameters:
      failureType - The type of transaction failure

    • setDeclineType

      public void setDeclineType(String declineType)
      The type of transaction failure (hard vs soft failure)
      Parameters:
      failureType - The type of transaction failure (hard vs soft failure)

    • setStatus

      public void setStatus(String status)
      The status of the transaction at the time this result was received
      Parameters:
      status - The status of the transaction at the time this result was received
      See Also:

    • setGatewayMessage

      public void setGatewayMessage(String gatewayMessage)
      Message from the gateway describing the result of the transaction.
      Parameters:
      gatewayMessage - Message from the gateway describing the result of the transaction.

    • setRawResponse

      public void setRawResponse(String rawResponse)
      The string representation of the serialized response from the gateway. This is usually the complete request parameter map serialized in string form.
      Parameters:
      rawResponse - The string representation of the serialized response from the gateway

    • setRequestId

      public void setRequestId(String requestId)
      The id used to represent the request that produced this transaction result.
      Parameters:
      requestId - The id used to represent the request that produced this transaction result

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Map of specific attributes that have been gathered from the raw response. This should be used for data points that are to be used programmatically.
      Parameters:
      attributes - Map of specific fields that have been gathered from the raw response

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Parameters:
      contextState - a subset of Tracking information to expose the context state for this object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object