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

Interface OfferEngineService

All Known Implementing Classes:

DefaultOfferEngineService

public interface OfferEngineService

This serves as the entry and exist points for the offer engine, which takes in an order and context then determines what offers can apply before calculating the best possible permutation of offers and applying them.

Author:

Chad Harchar (charchar)

Method Summary

Modifier and Type	Method	Description
void	applyAdjustments(EnhancedOrder order, OfferProcessingContext processingContext)	Applies the offers to the order in a way that gives the best discount for the customer based on possible permutations.
com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse	executeOnOrderAndContext(EnhancedOrder order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	For the provided order and context, determines the candidate offers and applies them to the order in the permutation that gives the best discount.
CandidateOffers	getCandidateOffers(EnhancedOrder order, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines all of the candidate offers that can apply to the provided order for the given context.
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	populateProratedItemAdjustments(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	populateProratedOrderAdjustments(EnhancedOrder order)	Populates all of the EnhancedProratedOfferAdjustments for any Offer that has a Discount.getTargetType() of DiscountTargetType.ORDER and add them onto the individual discountable order line items.

Method Detail

getCandidateOffers

@NonNull
CandidateOffers getCandidateOffers(@NonNull
                                   EnhancedOrder order,
                                   @Nullable
                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Determines all of the candidate offers that can apply to the provided order for the given context.

Parameters:

order - context information around the offer

contextInfo - Context information around sandbox and multitenant state.

Returns:

The list of offers that can apply to the provided order and context.

applyAdjustments

void applyAdjustments(@NonNull
                      EnhancedOrder order,
                      @NonNull
                      OfferProcessingContext processingContext)

Applies the offers to the order in a way that gives the best discount for the customer based on possible permutations.

Parameters:

order - the order to be considered for Offer discounts.

processingContext - all permutations of orders that can be considered for the order

executeOnOrderAndContext

com.broadleafcommerce.promotion.offer.client.web.context.discounts.OrderResponse executeOnOrderAndContext(@NonNull
                                                                                                          EnhancedOrder order,
                                                                                                          @Nullable
                                                                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

For the provided order and context, determines the candidate offers and applies them to the order in the permutation that gives the best discount.

Parameters:

order - context information around the offer

contextInfo - Context information around sandbox and multitenant state.

Returns:

A response DTO that details the adjustments and their discounts applied to the order

populateProratedItemAdjustments

@NonNull
void populateProratedItemAdjustments(@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 LineItems might have ProratedItemOfferAdjustments

populateProratedOrderAdjustments

@NonNull
void populateProratedOrderAdjustments(@NonNull
                                      EnhancedOrder order)

Populates all of the EnhancedProratedOfferAdjustments for any Offer that has a Discount.getTargetType() of DiscountTargetType.ORDER and add them onto the individual discountable order line items.

Parameters:

order - the EnhancedOrder to populate the order 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