Package com.broadleafcommerce.pricing.client.domain.usage

Class RecordPriceDataUsageRequest

java.lang.Object

com.broadleafcommerce.pricing.client.domain.usage.RecordPriceDataUsageRequest

All Implemented Interfaces:

Serializable

public class RecordPriceDataUsageRequest
extends Object
implements Serializable

Request DTO to record price data usages.

Useful for PriceData that are limited by quantity.

Since:

Pricing Client 2.0.3

Author:

Sunny Yu

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RecordPriceDataUsageRequest()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Object>	getAdditionalAttributes()	Miscellaneous attributes that can be added to this request in order to provide more information.
String	getCustomerReferenceId()	The ID of the customer this audit is for.
String	getCustomerReferenceType()	The transaction type this audit is for, e.g.
List<PriceDataUsage>	getPriceDataUsages()	The list of PriceDataUsages to record
String	getTransactionReferenceId()	The ix of the transaction that the price data was used in, e.g.
String	getTransactionReferenceType()	The type of the transaction that the price data was used in, e.g.
Instant	getUsageDate()	The usage date.
int	hashCode()
void	setAdditionalAttributes(Map<String,Object> additionalAttributes)	Miscellaneous attributes that can be added to this request in order to provide more information.
void	setCustomerReferenceId(String customerReferenceId)	The ID of the customer this audit is for.
void	setCustomerReferenceType(String customerReferenceType)	The transaction type this audit is for, e.g.
void	setPriceDataUsages(List<PriceDataUsage> priceDataUsages)	The list of PriceDataUsages to record
void	setTransactionReferenceId(String transactionReferenceId)	The ix of the transaction that the price data was used in, e.g.
void	setTransactionReferenceType(String transactionReferenceType)	The type of the transaction that the price data was used in, e.g.
void	setUsageDate(Instant usageDate)	The usage date.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RecordPriceDataUsageRequest

public RecordPriceDataUsageRequest()

Method Details

getTransactionReferenceType

public String getTransactionReferenceType()

The type of the transaction that the price data was used in, e.g. DefaultPriceDataTransactionReferenceTypes.BLC_CART.

See Also:

• DefaultPriceDataTransactionReferenceTypes

getTransactionReferenceId

public String getTransactionReferenceId()

The ix of the transaction that the price data was used in, e.g. cart id.

getCustomerReferenceType

public String getCustomerReferenceType()

The transaction type this audit is for, e.g. DefaultPriceDataCustomerReferenceTypes.

See Also:

• DefaultPriceDataCustomerReferenceTypes

getCustomerReferenceId

public String getCustomerReferenceId()

The ID of the customer this audit is for.

getPriceDataUsages

public List<PriceDataUsage> getPriceDataUsages()

The list of PriceDataUsages to record

getUsageDate

public Instant getUsageDate()

The usage date.

getAdditionalAttributes

public Map<String,Object> getAdditionalAttributes()

Miscellaneous attributes that can be added to this request in order to provide more information.

setTransactionReferenceType

public void setTransactionReferenceType(String transactionReferenceType)

The type of the transaction that the price data was used in, e.g. DefaultPriceDataTransactionReferenceTypes.BLC_CART.

See Also:

• DefaultPriceDataTransactionReferenceTypes

setTransactionReferenceId

public void setTransactionReferenceId(String transactionReferenceId)

The ix of the transaction that the price data was used in, e.g. cart id.

setCustomerReferenceType

public void setCustomerReferenceType(String customerReferenceType)

The transaction type this audit is for, e.g. DefaultPriceDataCustomerReferenceTypes.

See Also:

• DefaultPriceDataCustomerReferenceTypes

setCustomerReferenceId

public void setCustomerReferenceId(String customerReferenceId)

The ID of the customer this audit is for.

setPriceDataUsages

public void setPriceDataUsages(List<PriceDataUsage> priceDataUsages)

The list of PriceDataUsages to record

setUsageDate

public void setUsageDate(Instant usageDate)

The usage date.

setAdditionalAttributes

public void setAdditionalAttributes(Map<String,Object> additionalAttributes)

Miscellaneous attributes that can be added to this request in order to provide more information.

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