Package com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item

Class DefaultPotentialSavingsCalculator

java.lang.Object

com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

All Implemented Interfaces:

PotentialSavingsCalculator

public class DefaultPotentialSavingsCalculator
extends Object
implements PotentialSavingsCalculator

Author:

Nathan Moore (nathanmoore).

Constructor Summary

Constructors

Constructor	Description
DefaultPotentialSavingsCalculator(com.broadleafcommerce.common.extension.TypeFactory offerFactory)

Method Summary

Modifier and Type	Method	Description
protected void	assertCandidateOfferNotNull(CandidateItemOffer candidateOffer)
protected void	assertCommonParamsNotNull(EnhancedOrder order, CandidateItemOffer candidateOffer)
protected void	assertOfferNotNull(Offer offer)
javax.money.MonetaryAmount	calculateDiscountForItem(CandidateItemOffer itemOffer, EnhancedLineItem item, int quantityToReceiveDiscount)	Calculates the potential discount of a CandidateItemOffer for an EnhancedLineItem.
TotalPotentialSavings	calculatePotentialSavingsForOffer(EnhancedOrder order, CandidateItemOffer itemOffer, boolean isForFulfillment)	Calculates the TotalPotentialSavings for all of the given EnhancedOrder.getOrderLineItems() order's order line items} if the given CandidateItemOffer was applied.
protected BigDecimal	calculateSimplePercent(javax.money.MonetaryAmount itemSubTotal, javax.money.MonetaryAmount itemSavings)
protected BigDecimal	calculateWeightedPercent(EnhancedLineItem item, javax.money.MonetaryAmount itemSavings, boolean useSalePrice)
javax.money.MonetaryAmount	computeAdjustmentValue(javax.money.MonetaryAmount currentPrice, CandidateItemOffer itemOffer)	Calls PotentialSavingsCalculator.computeAdjustmentValue(javax.money.MonetaryAmount, com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer, double) with a proration amount of 1 meaning no proration.}
javax.money.MonetaryAmount	computeAdjustmentValue(javax.money.MonetaryAmount currentPrice, CandidateItemOffer itemOffer, double prorationAmount)	Computes the adjustment value of a CandidateItemOffer for a targeted EnhancedLineItem.
protected Optional<DiscountTier>	determineMaxTier(CandidateItemOffer itemOffer, List<DiscountTier> discountTiers)
protected DiscountParameters	determineOfferDiscountParameters(CandidateItemOffer itemOffer)	Determines the discount method type and discount amount for the candidate offer, accounting for Offer.getDiscountTiers().
void	finalizePotentialSavingsOnOffer(CandidateItemOffer itemOffer, TotalPotentialSavings totalPotentialSavings)	Saves the final BaseCandidateOffer.getPotentialSavings() and CandidateItemOffer.getWeightedPercentSaved() for all of an EnhancedOrder.getOrderLineItems() order's order items} if the given CandidateItemOffer was applied.
protected DiscountTier	getMaxTierForTieredItemQty(CandidateItemOffer itemOffer, List<DiscountTier> discountTiers, int quantityForTierOffer)
protected DiscountTier	getMaxTierForTieredItemSubtotal(CandidateItemOffer itemOffer, List<DiscountTier> discountTiers, BigDecimal amountForTierOffer)
protected com.broadleafcommerce.common.extension.TypeFactory	getOfferFactory()
protected boolean	isPercentOffOffer(Offer offer)
protected void	setPotentialSavings(CandidateItemOffer itemOffer, javax.money.MonetaryAmount potentialSavings)
protected void	setWeightedDiscountPercent(CandidateItemOffer itemOffer, BigDecimal weightedDiscountPercent)
protected boolean	shouldCalculateSimplePercent(Offer offer)
protected boolean	usePercentOffValue(Offer offer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultPotentialSavingsCalculator

public DefaultPotentialSavingsCalculator(com.broadleafcommerce.common.extension.TypeFactory offerFactory)

Method Details

calculatePotentialSavingsForOffer

@NonNull
public TotalPotentialSavings calculatePotentialSavingsForOffer(@NonNull
 EnhancedOrder order,
 @NonNull
 CandidateItemOffer itemOffer,
 boolean isForFulfillment)

Description copied from interface: PotentialSavingsCalculator

Calculates the TotalPotentialSavings for all of the given EnhancedOrder.getOrderLineItems() order's order line items} if the given CandidateItemOffer was applied.

Specified by:

calculatePotentialSavingsForOffer in interface PotentialSavingsCalculator

Parameters:

order - The EnhancedOrder for whose items to calculate potential savings provided by CandidateItemOffer

itemOffer - The CandidateItemOffer whose discount will be used to calculate potential savings

isForFulfillment - whether this calculation should use EnhancedOrder.getFulfillmentLineItems() instead of EnhancedOrder.getOrderLineItems()

Returns:

TotalPotentialSavings DTO containing the total savings info for all of the EnhancedOrder.getOrderLineItems() order's order items}

finalizePotentialSavingsOnOffer

public void finalizePotentialSavingsOnOffer(@NonNull
 CandidateItemOffer itemOffer,
 @NonNull
 TotalPotentialSavings totalPotentialSavings)

Description copied from interface: PotentialSavingsCalculator

Saves the final BaseCandidateOffer.getPotentialSavings() and CandidateItemOffer.getWeightedPercentSaved() for all of an EnhancedOrder.getOrderLineItems() order's order items} if the given CandidateItemOffer was applied.

Specified by:

finalizePotentialSavingsOnOffer in interface PotentialSavingsCalculator

Parameters:

itemOffer - The CandidateItemOffer whose discount was used to calculate the potential savings

totalPotentialSavings - TotalPotentialSavings DTO containing the total savings info for all of an EnhancedOrder.getOrderLineItems() order's order items}

calculateDiscountForItem

@NonNull
public javax.money.MonetaryAmount calculateDiscountForItem(@NonNull
 CandidateItemOffer itemOffer,
 @NonNull
 EnhancedLineItem item,
 int quantityToReceiveDiscount)

Description copied from interface: PotentialSavingsCalculator

Calculates the potential discount of a CandidateItemOffer for an EnhancedLineItem.

Specified by:

calculateDiscountForItem in interface PotentialSavingsCalculator

Parameters:

itemOffer - The CandidateItemOffer for which to find a potential discount.

item - The EnhancedLineItem to discount.

quantityToReceiveDiscount - The quantity of items in the EnhancedLineItem that can receive a discount from the offer

Returns:

the discount amount of a CandidateItemOffer for an EnhancedLineItem.

computeAdjustmentValue

@NonNull
public javax.money.MonetaryAmount computeAdjustmentValue(@NonNull
 javax.money.MonetaryAmount currentPrice,
 @NonNull
 CandidateItemOffer itemOffer)

Description copied from interface: PotentialSavingsCalculator

Calls PotentialSavingsCalculator.computeAdjustmentValue(javax.money.MonetaryAmount, com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer, double) with a proration amount of 1 meaning no proration.}

Specified by:

computeAdjustmentValue in interface PotentialSavingsCalculator

Returns:

the adjustment value of a CandidateItemOffer for a targeted EnhancedLineItem

computeAdjustmentValue

@NonNull
public javax.money.MonetaryAmount computeAdjustmentValue(@NonNull
 javax.money.MonetaryAmount currentPrice,
 @NonNull
 CandidateItemOffer itemOffer,
 double prorationAmount)

Description copied from interface: PotentialSavingsCalculator

Computes the adjustment value of a CandidateItemOffer for a targeted EnhancedLineItem. If the adjusted value is greater than the target order item's current price, then the current price is returned.

Specified by:

computeAdjustmentValue in interface PotentialSavingsCalculator

Parameters:

currentPrice - Current price of the EnhancedLineItem (may include previous orderAdjustments)

itemOffer - The CandidateItemOffer for which to find an adjustment value.

prorationAmount - For Offers with Offer.isDistributeOfferAmountToTargets(), the relative amount for the item being priced.

Returns:

the adjustment value of a CandidateItemOffer for a targeted EnhancedLineItem

determineOfferDiscountParameters

protected DiscountParameters determineOfferDiscountParameters(CandidateItemOffer itemOffer)

Determines the discount method type and discount amount for the candidate offer, accounting for Offer.getDiscountTiers().

Parameters:

itemOffer - CandidateItemOffer from which to retrieve discount parameters

Returns:

the discount method type and discount amount for the candidate offer

determineMaxTier

protected Optional<DiscountTier> determineMaxTier(CandidateItemOffer itemOffer,
 List<DiscountTier> discountTiers)

Parameters:

itemOffer -

discountTiers -

Returns:

The maximum tier that is eligible.

getMaxTierForTieredItemSubtotal

@Nullable
protected DiscountTier getMaxTierForTieredItemSubtotal(CandidateItemOffer itemOffer,
 List<DiscountTier> discountTiers,
 BigDecimal amountForTierOffer)

getMaxTierForTieredItemQty

@Nullable
protected DiscountTier getMaxTierForTieredItemQty(CandidateItemOffer itemOffer,
 List<DiscountTier> discountTiers,
 int quantityForTierOffer)

calculateSimplePercent

protected BigDecimal calculateSimplePercent(javax.money.MonetaryAmount itemSubTotal,
 javax.money.MonetaryAmount itemSavings)

calculateWeightedPercent

protected BigDecimal calculateWeightedPercent(EnhancedLineItem item,
 javax.money.MonetaryAmount itemSavings,
 boolean useSalePrice)

shouldCalculateSimplePercent

protected boolean shouldCalculateSimplePercent(@NonNull
 Offer offer)

assertOfferNotNull

protected void assertOfferNotNull(Offer offer)

isPercentOffOffer

protected boolean isPercentOffOffer(@NonNull
 Offer offer)

usePercentOffValue

protected boolean usePercentOffValue(@NonNull
 Offer offer)

setWeightedDiscountPercent

protected void setWeightedDiscountPercent(CandidateItemOffer itemOffer,
 BigDecimal weightedDiscountPercent)

setPotentialSavings

protected void setPotentialSavings(CandidateItemOffer itemOffer,
 javax.money.MonetaryAmount potentialSavings)

assertCommonParamsNotNull

protected void assertCommonParamsNotNull(EnhancedOrder order,
 CandidateItemOffer candidateOffer)

assertCandidateOfferNotNull

protected void assertCandidateOfferNotNull(CandidateItemOffer candidateOffer)

getOfferFactory

protected com.broadleafcommerce.common.extension.TypeFactory getOfferFactory()