Package com.broadleafcommerce.pricing.client.domain

Class PriceDetail

java.lang.Object

com.broadleafcommerce.pricing.client.domain.PriceDetail

All Implemented Interfaces:

PriceDetailComparable, Serializable

public class PriceDetail
extends Object
implements Serializable, PriceDetailComparable

Details about the candidate prices and their originating PriceListRef. These will be aggregated on a PriceInfo.

Author:

Chad Harchar (charchar)

See Also:

• PriceInfo
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PriceDetail()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Instant	getActiveEndDate()	Defines the ending time for which this price is active
Instant	getActiveStartDate()	Defines the beginning time for which this price is active.
Integer	getAvailableQuantity()	The available quantity that can use this price data.
javax.money.MonetaryAmount	getPrice()	Price for the PriceInfo.getTarget() for a particular PriceList.
String	getPriceDataId()	Id of the specific PriceData that this price came from.
List<PriceDataTierRef>	getPriceDataTierList()	PriceDataTiers for the PriceInfo.getTarget().
PriceListRef	getPriceList()
Integer	getPriceListPriority()	The relative priority of the parent price list vs other price lists that may have price details with the same target.
String	getPriceSource()	The source of this price within the price list, e.g.
String	getPriceType()	The originating type of this corresponding price.
Integer	getPriority()	The relative priority of this price detail vs others that might apply to the same target.
RecurringPriceDetail	getRecurringPriceDetail()	Represents the details related to a recurring (or subscription) price include the terms.
Integer	getStartingQuantity()	Defines the initial quantity available for this price data before a pricing event such as a flash sale.
UsagePriceDetail	getUsagePriceDetail()	Represents the details related to a usage price including the units.
int	hashCode()
boolean	hasLimitedQuantity()	Whether this price is limited by quantity.
void	setActiveEndDate(Instant activeEndDate)	Defines the ending time for which this price is active
void	setActiveStartDate(Instant activeStartDate)	Defines the beginning time for which this price is active.
void	setAvailableQuantity(Integer availableQuantity)	The available quantity that can use this price data.
void	setPrice(javax.money.MonetaryAmount price)
void	setPriceDataId(String priceDataId)	Id of the specific PriceData that this price came from.
void	setPriceDataTierList(List<PriceDataTierRef> priceDataTierList)	PriceDataTiers for the PriceInfo.getTarget().
void	setPriceList(PriceListRef priceList)
void	setPriceListPriority(Integer priceListPriority)
void	setPriceSource(String priceSource)	The source of this price within the price list, e.g.
void	setPriceType(String priceType)	The originating type of this corresponding price.
void	setPriority(Integer priority)
void	setRecurringPriceDetail(RecurringPriceDetail recurringPriceDetail)
void	setStartingQuantity(Integer startingQuantity)	Defines the initial quantity available for this price data before a pricing event such as a flash sale.
void	setUsagePriceDetail(UsagePriceDetail usagePriceDetail)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PriceDetail

public PriceDetail()

Method Details

hasLimitedQuantity

public boolean hasLimitedQuantity()

Whether this price is limited by quantity.

Since:

Pricing Client 2.0.3

getPrice

public javax.money.MonetaryAmount getPrice()

Description copied from interface: PriceDetailComparable

Price for the PriceInfo.getTarget() for a particular PriceList.

Specified by:

getPrice in interface PriceDetailComparable

Returns:

the Price for the PriceInfo.getTarget() for a particular PriceList.

See Also:

• PriceDetailComparable.getPrice()

getPriceDataId

public String getPriceDataId()

Id of the specific PriceData that this price came from.

Only applicable if the priceSource is DefaultPriceListPriceSources.BLC_PRICE_LIST_PRICE_DATA.

Since:

Pricing Client 2.0.3

getRecurringPriceDetail

public RecurringPriceDetail getRecurringPriceDetail()

Description copied from interface: PriceDetailComparable

Represents the details related to a recurring (or subscription) price include the terms.

Specified by:

getRecurringPriceDetail in interface PriceDetailComparable

Returns:

Represents the details related to a recurring (or subscription) price include the terms.

Since:

Pricing Client 2.0.3

See Also:

• PriceDetailComparable.getRecurringPriceDetail()

getUsagePriceDetail

public UsagePriceDetail getUsagePriceDetail()

Description copied from interface: PriceDetailComparable

Represents the details related to a usage price including the units.

Specified by:

getUsagePriceDetail in interface PriceDetailComparable

Returns:

Represents the details related to a usage price including the units.

Since:

Pricing Client 2.0.3

See Also:

• PriceDetailComparable.getUsagePriceDetail()

getPriceList

public PriceListRef getPriceList()

See Also:

• PriceListRef

getPriceSource

public String getPriceSource()

The source of this price within the price list, e.g. price list formula, price list price data, etc.

This may be helpful for consuming services to determine the priority of the price. For example, a price from DefaultPriceListPriceSources.BLC_PRICE_LIST_PRICE_DATA may have a higher precedence over DefaultPriceListPriceSources.BLC_PRICE_LIST_FORMULA.

Since:

1.4.1, 2.0.1

See Also:

• DefaultPriceListPriceSources

getActiveStartDate

public Instant getActiveStartDate()

Defines the beginning time for which this price is active.

Since:

Pricing Client 2.0.3

getActiveEndDate

public Instant getActiveEndDate()

Defines the ending time for which this price is active

Since:

Pricing Client 2.0.3

getStartingQuantity

public Integer getStartingQuantity()

Defines the initial quantity available for this price data before a pricing event such as a flash sale. It only serves an informational purpose.

Since:

Pricing Client 2.0.3

getAvailableQuantity

public Integer getAvailableQuantity()

The available quantity that can use this price data. This is used for events such as a flash sale where the sale price is limited to a certain amount of quantity.

Since:

Pricing Client 2.0.3

getPriceType

public String getPriceType()

The originating type of this corresponding price.

getPriceDataTierList

public List<PriceDataTierRef> getPriceDataTierList()

PriceDataTiers for the PriceInfo.getTarget().

See Also:

• PriceDataTierRef

getPriority

public Integer getPriority()

Description copied from interface: PriceDetailComparable

The relative priority of this price detail vs others that might apply to the same target.

Specified by:

getPriority in interface PriceDetailComparable

Returns:

The relative priority of this price detail vs others that might apply to the same target.

Since:

PricingService 2.0.3

See Also:

• PriceDetailComparable.getPriority()

getPriceListPriority

public Integer getPriceListPriority()

Description copied from interface: PriceDetailComparable

The relative priority of the parent price list vs other price lists that may have price details with the same target.

Specified by:

getPriceListPriority in interface PriceDetailComparable

Returns:

The relative priority of the parent price list vs other price lists that may have price details with the same target.

Since:

Pricing Client 2.0.3

See Also:

• PriceDetailComparable.getPriceListPriority()

setPrice

public void setPrice(javax.money.MonetaryAmount price)

See Also:

• PriceDetailComparable.getPrice()

setPriceDataId

public void setPriceDataId(String priceDataId)

Id of the specific PriceData that this price came from.

Only applicable if the priceSource is DefaultPriceListPriceSources.BLC_PRICE_LIST_PRICE_DATA.

Since:

Pricing Client 2.0.3

setRecurringPriceDetail

public void setRecurringPriceDetail(RecurringPriceDetail recurringPriceDetail)

Since:

Pricing Client 2.0.3

See Also:

• PriceDetailComparable.getRecurringPriceDetail()

setUsagePriceDetail

public void setUsagePriceDetail(UsagePriceDetail usagePriceDetail)

Since:

Pricing Client 2.0.3

See Also:

• PriceDetailComparable.getUsagePriceDetail()

setPriceList

public void setPriceList(PriceListRef priceList)

See Also:

• PriceListRef

setPriceSource

public void setPriceSource(String priceSource)

The source of this price within the price list, e.g. price list formula, price list price data, etc.

This may be helpful for consuming services to determine the priority of the price. For example, a price from DefaultPriceListPriceSources.BLC_PRICE_LIST_PRICE_DATA may have a higher precedence over DefaultPriceListPriceSources.BLC_PRICE_LIST_FORMULA.

Since:

1.4.1, 2.0.1

See Also:

• DefaultPriceListPriceSources

setActiveStartDate

public void setActiveStartDate(Instant activeStartDate)

Defines the beginning time for which this price is active.

Since:

Pricing Client 2.0.3

setActiveEndDate

public void setActiveEndDate(Instant activeEndDate)

Defines the ending time for which this price is active

Since:

Pricing Client 2.0.3

setStartingQuantity

public void setStartingQuantity(Integer startingQuantity)

Defines the initial quantity available for this price data before a pricing event such as a flash sale. It only serves an informational purpose.

Since:

Pricing Client 2.0.3

setAvailableQuantity

public void setAvailableQuantity(Integer availableQuantity)

The available quantity that can use this price data. This is used for events such as a flash sale where the sale price is limited to a certain amount of quantity.

Since:

Pricing Client 2.0.3

setPriceType

public void setPriceType(String priceType)

The originating type of this corresponding price.

setPriceDataTierList

public void setPriceDataTierList(List<PriceDataTierRef> priceDataTierList)

PriceDataTiers for the PriceInfo.getTarget().

See Also:

• PriceDataTierRef

setPriority

public void setPriority(Integer priority)

Since:

PricingService 2.0.3

See Also:

• PriceDetailComparable.getPriority()

setPriceListPriority

public void setPriceListPriority(Integer priceListPriority)

Since:

Pricing Client 2.0.3

See Also:

• PriceDetailComparable.getPriceListPriority()

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