Package com.broadleafcommerce.promotion.offer.service.engine.proration

Class DefaultProrationService

java.lang.Object

com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

All Implemented Interfaces:

ProrationService

public class DefaultProrationService
extends Object
implements ProrationService

Author:

Nathan Moore (nathanmoore).

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.broadleafcommerce.common.extension.TypeFactory	offerFactory

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addProratedItemOfferAdjustmentsToParentOfferDetails(Collection<? extends EnhancedProratedItemOfferAdjustment> proratedAdjustments)	Adds the ProratedItemOfferAdjustments to their parent LineItemOfferDetails
Set<EnhancedProratedOfferAdjustment>	buildProratedOrderAdjustments(OrderOfferAdjustment offerAdjustment, List<? extends EnhancedLineItem> lineItems, DiscountableItemInfo discountableItemInfo)	Builds a list of EnhancedProratedOfferAdjustments that prorates the adjustment value of the passed in OrderOfferAdjustment to the passed in list of relevant EnhancedLineItems
protected javax.money.MonetaryAmount	calculateProratedAmount(ItemOfferAdjustment adjustment, int itemQty)
Set<EnhancedProratedItemOfferAdjustment>	calculateProratedItemAdjustments(EnhancedOrder order)	For any Offer that has a Discount.prorationType of ProrationType.TARGET_AND_QUALIFIER, this will populate all of the ProratedItemOfferAdjustments on the LineItemOfferDetails mostly for the sake of reporting instruments.
protected EnhancedProratedItemOfferAdjustment	calculateProrationItemAdjustment(ItemOfferAdjustment adjustment)
protected com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef	createLineItemRef(EnhancedLineItem lineItem)
protected com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef	createOfferRef(Offer offer)
protected EnhancedProratedItemOfferAdjustment	createProratedAdjustment(Offer offer, EnhancedLineItem lineItem, LineItemOfferDetail parentDetail, javax.money.MonetaryAmount proratedAmt, int quantity)
protected Set<ItemOfferAdjustment>	getAllAdjustments(EnhancedOrder order)
protected String	getCustomLineItemType(EnhancedLineItem lineItem)
protected javax.money.MonetaryAmount	getDiscountableItemsTotal(javax.money.MonetaryAmount startingAmount, List<? extends EnhancedLineItem> lineItems)	Gets the discountable total for the given EnhancedLineItems.
protected String	getLineItemType(EnhancedLineItem lineItem)
protected MoneyRoundingHelper	getMoneyRoundingHelper()
protected boolean	isMatchingQualifier(Offer offer, OfferQualifier qualifier)
protected boolean	isProrationRequiredForAdjustment(ItemOfferAdjustment adjustment)
protected void	populateItemQuantitesProrationDetails(@NonNull Set<EnhancedProratedOfferAdjustment> proratedOfferAdjustments)	Populates ItemProrationDetails to represent how an EnhancedProratedOfferAdjustment can be prorated down to an item quantity level.
protected void	populateProratedFulfillmentGroupAdjustments(EnhancedFulfillmentGroup group)	Populates the prorated fulfillment group adjustments for the given EnhancedFulfillmentGroup.
void	populateProratedFulfillmentGroupAdjustments(EnhancedOrder order)	Populates all of the EnhancedProratedOfferAdjustments for any Offer that has a Discount.getTargetType() of DiscountTargetType.FULFILLMENT_GROUP and add them onto the individual discountable fulfillment items, as well as populating EnhancedFulfillmentGroup.getProratedFulfillmentAdjustments().
protected void	populateProratedFulfillmentGroupAdjustments(FulfillmentGroupAdjustment fgAdjustment, EnhancedFulfillmentGroup group)	Populates the prorated fulfillment group adjustments from the given FulfillmentGroupAdjustment across the given fulfillment items and the given EnhancedFulfillmentGroup.
void	populateProratedOrderAdjustments(EnhancedOrder order, OfferProcessingContext context)	Populates all of the EnhancedProratedOfferAdjustments for any Offer that has a Discount.getTargetType() of DiscountTargetType.ORDER and add them onto the individual discountable fulfillment items, as well as populating EnhancedFulfillmentGroup.getProratedFulfillmentAdjustments().
protected Set<EnhancedProratedOfferAdjustment>	prorateAdjustmentAmongItems(Offer offer, javax.money.MonetaryAmount adjustmentAmount, DiscountableItemInfo discountableItemInfo, List<? extends EnhancedLineItem> lineItems, boolean updateItem)	Prorates the given adjustment across the given EnhancedLineItems.
void	setMoneyRoundingHelper(MoneyRoundingHelper moneyRoundingHelper)
protected boolean	shouldProrateAdjustment(FulfillmentGroupAdjustment adjustment)	Determines whether the given FulfillmentGroupAdjustment should be prorated across the fulfillment items.
protected boolean	shouldProrateAdjustment(OrderOfferAdjustment adjustment)	Determines whether the given OrderOfferAdjustment should be prorated across the order line items.
protected final javax.money.MonetaryAmount	zeroIfNull(javax.money.MonetaryAmount amount, javax.money.CurrencyUnit currency)	Defaults the amount to zero if null.

Methods inherited from class java.lang.Object

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

Field Details

offerFactory

protected final com.broadleafcommerce.common.extension.TypeFactory offerFactory

Constructor Details

DefaultProrationService

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

Method Details

addProratedItemOfferAdjustmentsToParentOfferDetails

public void addProratedItemOfferAdjustmentsToParentOfferDetails(@NonNull
 Collection<? extends EnhancedProratedItemOfferAdjustment> proratedAdjustments)

Description copied from interface: ProrationService

Adds the ProratedItemOfferAdjustments to their parent LineItemOfferDetails

Specified by:

addProratedItemOfferAdjustmentsToParentOfferDetails in interface ProrationService

Parameters:

proratedAdjustments - ProratedItemOfferAdjustments to be added

calculateProratedItemAdjustments

@NonNull
public Set<EnhancedProratedItemOfferAdjustment> calculateProratedItemAdjustments(@NonNull
 EnhancedOrder order)

Description copied from interface: ProrationService

For any Offer that has a Discount.prorationType of ProrationType.TARGET_AND_QUALIFIER, this will populate all of the ProratedItemOfferAdjustments on the LineItemOfferDetails mostly for the sake of reporting instruments.

Specified by:

calculateProratedItemAdjustments in interface ProrationService

Parameters:

order - the EnhancedOrder whose items may need ProratedItemOfferAdjustments

Returns:

all of the ProratedItemOfferAdjustments for this Order's order and fulfillment LineItems.

populateProratedOrderAdjustments

public void populateProratedOrderAdjustments(@NonNull
 EnhancedOrder order,
 OfferProcessingContext context)

Description copied from interface: ProrationService

Populates all of the EnhancedProratedOfferAdjustments for any Offer that has a Discount.getTargetType() of DiscountTargetType.ORDER and add them onto the individual discountable fulfillment items, as well as populating EnhancedFulfillmentGroup.getProratedFulfillmentAdjustments().

Specified by:

populateProratedOrderAdjustments in interface ProrationService

Parameters:

order - the EnhancedOrder to populate the fulfillment group offer adjustment prorations

populateProratedFulfillmentGroupAdjustments

@NonNull
public void populateProratedFulfillmentGroupAdjustments(@NonNull
 EnhancedOrder order)

Description copied from interface: ProrationService

Populates all of the EnhancedProratedOfferAdjustments for any Offer that has a Discount.getTargetType() of DiscountTargetType.FULFILLMENT_GROUP and add them onto the individual discountable fulfillment items, as well as populating EnhancedFulfillmentGroup.getProratedFulfillmentAdjustments().

Specified by:

populateProratedFulfillmentGroupAdjustments in interface ProrationService

Parameters:

order - the EnhancedOrder to populate the fulfillment group offer adjustment prorations

getAllAdjustments

protected Set<ItemOfferAdjustment> getAllAdjustments(EnhancedOrder order)

isProrationRequiredForAdjustment

protected boolean isProrationRequiredForAdjustment(ItemOfferAdjustment adjustment)

shouldProrateAdjustment

protected boolean shouldProrateAdjustment(OrderOfferAdjustment adjustment)

Determines whether the given OrderOfferAdjustment should be prorated across the order line items.

Returns true by default, any custom logic should be added here.

Parameters:

adjustment - the OrderOfferAdjustment to check against

Returns:

true if the given OrderOfferAdjustment should be prorated across the order line items

shouldProrateAdjustment

protected boolean shouldProrateAdjustment(FulfillmentGroupAdjustment adjustment)

Determines whether the given FulfillmentGroupAdjustment should be prorated across the fulfillment items.

Returns true by default, any custom logic should be added here.

Parameters:

adjustment - the FulfillmentGroupAdjustment to check against

Returns:

true if the given FulfillmentGroupAdjustment should be prorated across the fulfillment items

calculateProrationItemAdjustment

protected EnhancedProratedItemOfferAdjustment calculateProrationItemAdjustment(ItemOfferAdjustment adjustment)

buildProratedOrderAdjustments

public Set<EnhancedProratedOfferAdjustment> buildProratedOrderAdjustments(@NonNull
 OrderOfferAdjustment offerAdjustment,
 @NonNull
 List<? extends EnhancedLineItem> lineItems,
 DiscountableItemInfo discountableItemInfo)

Description copied from interface: ProrationService

Builds a list of EnhancedProratedOfferAdjustments that prorates the adjustment value of the passed in OrderOfferAdjustment to the passed in list of relevant EnhancedLineItems

Specified by:

buildProratedOrderAdjustments in interface ProrationService

Parameters:

offerAdjustment - the OrderOfferAdjustment to prorate.

lineItems - the list of relevant EnhancedLineItems to

Returns:

the list of EnhancedProratedOfferAdjustments

populateProratedFulfillmentGroupAdjustments

protected void populateProratedFulfillmentGroupAdjustments(EnhancedFulfillmentGroup group)

Populates the prorated fulfillment group adjustments for the given EnhancedFulfillmentGroup.

Parameters:

group - the EnhancedFulfillmentGroup to populate the prorations for

populateProratedFulfillmentGroupAdjustments

protected void populateProratedFulfillmentGroupAdjustments(FulfillmentGroupAdjustment fgAdjustment,
 EnhancedFulfillmentGroup group)

Populates the prorated fulfillment group adjustments from the given FulfillmentGroupAdjustment across the given fulfillment items and the given EnhancedFulfillmentGroup.

Parameters:

fgAdjustment - the FulfillmentGroupAdjustment to prorate across the EnhancedFulfillmentGroup and fulfillment items

group - the EnhancedFulfillmentGroup to populate the prorations for

getDiscountableItemsTotal

protected javax.money.MonetaryAmount getDiscountableItemsTotal(javax.money.MonetaryAmount startingAmount,
 List<? extends EnhancedLineItem> lineItems)

Gets the discountable total for the given EnhancedLineItems.

Parameters:

startingAmount - the amount to start with

lineItems - the EnhancedLineItems to calculate the discountable total for

Returns:

the discountable total for the given EnhancedLineItems

prorateAdjustmentAmongItems

protected Set<EnhancedProratedOfferAdjustment> prorateAdjustmentAmongItems(Offer offer,
 javax.money.MonetaryAmount adjustmentAmount,
 DiscountableItemInfo discountableItemInfo,
 List<? extends EnhancedLineItem> lineItems,
 boolean updateItem)

Prorates the given adjustment across the given EnhancedLineItems.

Parameters:

offer - the Offer where the adjustment came from

adjustmentAmount - the adjustment amount to prorate

discountableItemInfo - structure with item discount information

lineItems - the EnhancedLineItems to prorate across

Returns:

the populated adjustment prorations added to the given EnhancedLineItems. The list can be used later on for rounding

populateItemQuantitesProrationDetails

protected void populateItemQuantitesProrationDetails(@NonNull
 @NonNull Set<EnhancedProratedOfferAdjustment> proratedOfferAdjustments)

Populates ItemProrationDetails to represent how an EnhancedProratedOfferAdjustment can be prorated down to an item quantity level.

For example, if a EnhancedProratedOfferAdjustment.getAmount() is $5 and the item's quantity is 3, this method will produce two ItemProrationDetails representing how the discount would be prorated based on the item's quantity, one with quantity of 2 and amount of $1.67, and one with quantity of 1 and amount of $1.66, totaling to $5

Parameters:

proratedOfferAdjustments - the EnhancedProratedOfferAdjustments to prorate

isMatchingQualifier

protected boolean isMatchingQualifier(Offer offer,
 OfferQualifier qualifier)

calculateProratedAmount

protected javax.money.MonetaryAmount calculateProratedAmount(ItemOfferAdjustment adjustment,
 int itemQty)

createProratedAdjustment

protected EnhancedProratedItemOfferAdjustment createProratedAdjustment(Offer offer,
 EnhancedLineItem lineItem,
 LineItemOfferDetail parentDetail,
 javax.money.MonetaryAmount proratedAmt,
 int quantity)

createLineItemRef

protected com.broadleafcommerce.promotion.offer.client.web.context.info.LineItemRef createLineItemRef(EnhancedLineItem lineItem)

getLineItemType

protected String getLineItemType(EnhancedLineItem lineItem)

getCustomLineItemType

protected String getCustomLineItemType(EnhancedLineItem lineItem)

createOfferRef

protected com.broadleafcommerce.promotion.offer.client.web.context.info.OfferRef createOfferRef(Offer offer)

zeroIfNull

protected final javax.money.MonetaryAmount zeroIfNull(@Nullable
 javax.money.MonetaryAmount amount,
 @Nullable
 javax.money.CurrencyUnit currency)

Defaults the amount to zero if null.

Parameters:

amount - The MonetaryAmount to default to zero

currency - The amount's CurrencyUnit

Returns:

The amount or zero if null.

getMoneyRoundingHelper

protected MoneyRoundingHelper getMoneyRoundingHelper()

setMoneyRoundingHelper

@Autowired
public void setMoneyRoundingHelper(MoneyRoundingHelper moneyRoundingHelper)