Package com.broadleafcommerce.paymenttransaction.service.domain

Class TransactionSummaryRequest

java.lang.Object
com.broadleafcommerce.paymenttransaction.service.domain.TransactionSummaryRequest
All Implemented Interfaces:
Serializable
public class TransactionSummaryRequest extends Object implements Serializable
The request DTO containing the information to fetch a TransactionSummary
Author:
Chris Kittrell (ckittrell)
See Also:

  • Constructor Details

    • TransactionSummaryRequest

      public TransactionSummaryRequest()

  • Method Details

    • getOwnerType

      public String getOwnerType()
      Describes the owner of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.
      Returns:
      The type describing the owner of the payment

    • getOwnerId

      public String getOwnerId()
      The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.
      Returns:
      The id of the entity that owns this payment.

    • shouldIncludeFailedTransactions

      public boolean shouldIncludeFailedTransactions()
      Whether to include failed transactions.
      Returns:
      Whether to include failed transactions.

    • shouldIncludeReversedOrReversalTransactions

      public boolean shouldIncludeReversedOrReversalTransactions()
      Whether to include transactions that were automatically reversed or automatically reversed another transaction.
      Returns:
      Whether to include transactions that were automatically reversed or automatically reversed another transaction.

    • getAdditionalAttributes

      public Map<String,Object> getAdditionalAttributes()
      Additional attributes that can be declared for this request.

    • setOwnerType

      public void setOwnerType(String ownerType)
      Describes the owner of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.
      Parameters:
      ownerType - The type describing the owner of the payment

    • setOwnerId

      public void setOwnerId(String ownerId)
      The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.
      Parameters:
      ownerId - The id of the entity that owns this payment.

    • shouldIncludeFailedTransactions

      public TransactionSummaryRequest shouldIncludeFailedTransactions(boolean shouldIncludeFailedTransactions)
      Whether to include failed transactions.
      Parameters:
      shouldIncludeFailedTransactions - Whether to include failed transactions.
      Returns:
      this.

    • shouldIncludeReversedOrReversalTransactions

      public TransactionSummaryRequest shouldIncludeReversedOrReversalTransactions(boolean shouldIncludeReversedOrReversalTransactions)
      Whether to include transactions that were automatically reversed or automatically reversed another transaction.
      Parameters:
      shouldIncludeReversedOrReversalTransactions - Whether to include transactions that were automatically reversed or automatically reversed another transaction.
      Returns:
      this.

    • setAdditionalAttributes

      public void setAdditionalAttributes(Map<String,Object> additionalAttributes)
      Additional attributes that can be declared for this request.

    • 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