Package com.broadleafcommerce.paymenttransaction.web.endpoint.domain

Class LockPaymentRequest

java.lang.Object
com.broadleafcommerce.paymenttransaction.web.endpoint.domain.LockPaymentRequest
All Implemented Interfaces:
Serializable
public class LockPaymentRequest extends Object implements Serializable
A request DTO used to establish locks on a set of Payments.
Author:
Chris Kittrell (ckittrell)
See Also:

  • Constructor Details

    • LockPaymentRequest

      public LockPaymentRequest()

  • Method Details

    • hasPaymentIds

      public boolean hasPaymentIds()

    • hasOwnerTypeAndId

      public boolean hasOwnerTypeAndId()

    • getPaymentIds

      public List<String> getPaymentIds()
      The list of ids of the payments to lock.

      If this is not provided, then ownerType and ownerId are used to lock the payments.

    • 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.

      This will be ignored if paymentIds are provided.

      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.

      This will be ignored if paymentIds are provided.

      Returns:
      The id of the entity that owns this payment.

    • setPaymentIds

      public void setPaymentIds(List<String> paymentIds)
      The list of ids of the payments to lock.

      If this is not provided, then ownerType and ownerId are used to lock the payments.

    • 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.

      This will be ignored if paymentIds are provided.

      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.

      This will be ignored if paymentIds are provided.

      Parameters:
      ownerId - The id of the entity that owns this payment.

    • 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