Package com.broadleafcommerce.orderoperation.service.provider.external.domain.payment

Class LockPaymentRequest

java.lang.Object

com.broadleafcommerce.orderoperation.service.provider.external.domain.payment.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:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LockPaymentRequest()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getOwnerId()	The id of the entity that owns this payment.
String	getOwnerType()	Describes the owner of the payment.
List<String>	getPaymentIds()	The list of ids of the payments to lock.
int	hashCode()
void	setOwnerId(String ownerId)	The id of the entity that owns this payment.
void	setOwnerType(String ownerType)	Describes the owner of the payment.
void	setPaymentIds(List<String> paymentIds)	The list of ids of the payments to lock.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LockPaymentRequest

public LockPaymentRequest()

Method Detail

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.

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.

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.

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.

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