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

Interface ProrationService

All Known Implementing Classes:

DefaultProrationService

public interface ProrationService

Calculates all of an Order's order and fulfillment LineItems' ProratedItemOfferAdjustments.

Author:

Nathan Moore (nathanmoore).

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
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.
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().
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().

Method Details

calculateProratedItemAdjustments

@NonNull
Set<EnhancedProratedItemOfferAdjustment> calculateProratedItemAdjustments(@NonNull
 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.

Parameters:

order - the EnhancedOrder whose items may need ProratedItemOfferAdjustments

Returns:

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

buildProratedOrderAdjustments

@NonNull
Set<EnhancedProratedOfferAdjustment> buildProratedOrderAdjustments(@NonNull
 OrderOfferAdjustment offerAdjustment,
 @NonNull
 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

Parameters:

offerAdjustment - the OrderOfferAdjustment to prorate.

lineItems - the list of relevant EnhancedLineItems to

discountableItemInfo -

Returns:

the list of EnhancedProratedOfferAdjustments

populateProratedOrderAdjustments

@NonNull
void populateProratedOrderAdjustments(@NonNull
 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().

Parameters:

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

populateProratedFulfillmentGroupAdjustments

@NonNull
void populateProratedFulfillmentGroupAdjustments(@NonNull
 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().

Parameters:

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

addProratedItemOfferAdjustmentsToParentOfferDetails

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

Adds the ProratedItemOfferAdjustments to their parent LineItemOfferDetails

Parameters:

proratedAdjustments - ProratedItemOfferAdjustments to be added