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

Interface PotentialSavingsCalculator

All Known Implementing Classes:

DefaultPotentialSavingsCalculator

public interface PotentialSavingsCalculator

This service is responsible for calculating the potential savings for Offer target items if that offer is was the only offer applied. It is typically used by ItemOfferProcessor#calculatePotentialSavings(EnhancedOrder, CandidateOffers) because of how complex the calculation process is for EnhancedLineItem discounts.

Author:

Nathan Moore (nathanmoore).

Method Summary

Modifier and Type	Method	Description
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.
javax.money.MonetaryAmount	computeAdjustmentValue(javax.money.MonetaryAmount currentPrice, CandidateItemOffer itemOffer)	Calls 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.
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.

Method Details

calculatePotentialSavingsForOffer

@NonNull
TotalPotentialSavings calculatePotentialSavingsForOffer(@NonNull
 EnhancedOrder order,
 @NonNull
 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.

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

void finalizePotentialSavingsOnOffer(@NonNull
 CandidateItemOffer itemOffer,
 @NonNull
 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.

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
javax.money.MonetaryAmount calculateDiscountForItem(@NonNull
 CandidateItemOffer itemOffer,
 @NonNull
 EnhancedLineItem item,
 int quantityToReceiveDiscount)

Calculates the potential discount of a CandidateItemOffer for an EnhancedLineItem.

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
javax.money.MonetaryAmount computeAdjustmentValue(@NonNull
 javax.money.MonetaryAmount currentPrice,
 @NonNull
 CandidateItemOffer itemOffer,
 double prorationAmount)

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.

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

computeAdjustmentValue

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

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

Returns:

the adjustment value of a CandidateItemOffer for a targeted EnhancedLineItem