Package com.broadleafcommerce.promotion.offer.service.dto

Class OfferProcessingContext

java.lang.Object

com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

All Implemented Interfaces:

Serializable

public class OfferProcessingContext
extends Object
implements Serializable

This object manages the full list of permutations for a given execution of the offer engine and provides methods to determine the correct mix of offers for the final result.

Author:

Brian Polster (bpolster)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OfferProcessingContext()
OfferProcessingContext(EnhancedOrder order, CandidateOffers offers)

Method Summary

Modifier and Type	Method	Description
protected void	addToListIfPresent(List<Set<OfferCombinabilityCriteria>> criteriaByTypeList, Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria> permutationMap)	Each element in the list represents a single offer type and the unique set of OfferCombinabilityCriteria objects.
protected void	buildOfferPermutationsForCriteria(OfferCombinabilityCriteria criteria)	This method builds all compatible permutations of offers in a tree structure.
protected boolean	checkCompatability(BaseCandidateOffer candidateOffer, BaseCandidateOffer otherCandidateOffer, CompatibleOfferNode node)
protected boolean	checkForCombinable(BaseCandidateOffer candidateOffer, BaseCandidateOffer otherOffer)
protected boolean	checkForExplicitExclusions(BaseCandidateOffer candidateOffer, BaseCandidateOffer otherCandidateOffer)
protected boolean	checkForStackable(BaseCandidateOffer candidateOffer, BaseCandidateOffer otherOffer)
protected boolean	checkSegmentCombinable(BaseCandidateOffer offer, CompatibleOfferNode currentNode)	If this is an order offer and the segment is unique with the node path, then this offer can be combined.
protected void	copyBestPermutationCodeResponses()
protected com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse	createCodeResponse(OfferNotAppliedReasonEnum notUsedReason, com.broadleafcommerce.common.extension.TypeFactory offerFactory, org.springframework.context.MessageSource messageSource)
void	createPathsForNode(CompatibleOfferNode currentNode, List<BaseCandidateOffer> theOffers, Set<CompatibleOfferNode> allNodes)
List<BaseCandidateOffer>	filterIncompatibleOffers(BaseCandidateOffer offer, CompatibleOfferNode node, List<BaseCandidateOffer> otherOffers)	Filters the passed in list, removing all incompatible offers
BaseCandidateOffer	findFirstCompatibleOffer(BaseCandidateOffer offer, CompatibleOfferNode node, List<BaseCandidateOffer> otherOffers)
BaseCandidateOffer	findFirstIncompatibleOffer(BaseCandidateOffer offer, CompatibleOfferNode node, List<BaseCandidateOffer> otherOffers)	Based on the compatible flag, return the first compatible or incompatible item from the passed in list
protected Set<Offer>	getAppliedFulfillmentGroupOffers()
protected Set<Offer>	getAppliedFulfillmentItemOffers()
protected Set<Offer>	getAppliedOrderItemOffers()
protected Set<Offer>	getAppliedOrderOffers()
Optional<CombinedTypesOfferPermutation>	getBestOfferPermutation()
List<OrderOfferAdjustment>	getBestOrderAdjustmentsForTesting()	Method facilitates unit testing.
List<CandidateItemOffer>	getCandidateFulfillmentItemOffers()
CandidateOffers	getCandidateOffers()
List<CandidateItemOffer>	getCandidateOrderItemOffers()
List<CombinedTypesOfferPermutation>	getCombinedTypesOfferPermutations()
List<Set<OfferCombinabilityCriteria>>	getCriteriaSetsByType()	Builds a list consisting of the sets of OfferCombinabilityCriteria for each offer type.
Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria>	getFulfillmentGroupCriteriaMap()
Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria>	getFulfillmentItemCriteriaMap()
Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria>	getItemOfferCriteriaMap()
Map<String,List<EnhancedProratedOfferAdjustment>>	getItemProratedAdjustmentsMap()
EnhancedOrder	getOrder()
Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria>	getOrderOfferCriteriaMap()
Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria>	getVoucherCriteriaMap()
boolean	hasOffers()
void	initialize(EnhancedOrder order, CandidateOffers offers)	Initializes the core fields of the context.
void	initializePermutations()	Build unique permutations by offer type where a permutation is grouped by how the permutation can combine with other offer types
protected void	initializePermutations(List<? extends BaseCandidateOffer> offers, Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria> permutationMap)
boolean	isHasOffers()
protected boolean	isNotAppliedOffer(Set<Offer> appliedOffers, Offer offer)
void	setBestOfferPermutation(CombinedTypesOfferPermutation bestOfferPermutation)
void	updateBestCombinedTypesPermutation()
void	updateOfferNotAppliedResponses(com.broadleafcommerce.common.extension.TypeFactory offerFactory, org.springframework.context.MessageSource messageSource)

Methods inherited from class java.lang.Object

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

Constructor Details

OfferProcessingContext

public OfferProcessingContext(EnhancedOrder order,
 CandidateOffers offers)

OfferProcessingContext

public OfferProcessingContext()

Method Details

initialize

public void initialize(EnhancedOrder order,
 CandidateOffers offers)

Initializes the core fields of the context.

Parameters:

order - The source EnhancedOrder

offers - The candidate offers

Since:

Offer Service 3.1.0, Release Train 2.2.0

hasOffers

public boolean hasOffers()

getCandidateOrderItemOffers

public List<CandidateItemOffer> getCandidateOrderItemOffers()

getCandidateFulfillmentItemOffers

public List<CandidateItemOffer> getCandidateFulfillmentItemOffers()

initializePermutations

public void initializePermutations()

Build unique permutations by offer type where a permutation is grouped by how the permutation can combine with other offer types

See Also:

• OfferCombinabilityCriteriaKey

initializePermutations

protected void initializePermutations(List<? extends BaseCandidateOffer> offers,
 Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria> permutationMap)

buildOfferPermutationsForCriteria

protected void buildOfferPermutationsForCriteria(OfferCombinabilityCriteria criteria)

This method builds all compatible permutations of offers in a tree structure. Each path of this tree represents a unique offer permutation.

Parameters:

criteria - OfferCombinabilityCriteria to group offers by

createPathsForNode

public void createPathsForNode(CompatibleOfferNode currentNode,
 List<BaseCandidateOffer> theOffers,
 Set<CompatibleOfferNode> allNodes)

filterIncompatibleOffers

public List<BaseCandidateOffer> filterIncompatibleOffers(BaseCandidateOffer offer,
 CompatibleOfferNode node,
 List<BaseCandidateOffer> otherOffers)

Filters the passed in list, removing all incompatible offers

findFirstIncompatibleOffer

public BaseCandidateOffer findFirstIncompatibleOffer(BaseCandidateOffer offer,
 CompatibleOfferNode node,
 List<BaseCandidateOffer> otherOffers)

Based on the compatible flag, return the first compatible or incompatible item from the passed in list

findFirstCompatibleOffer

public BaseCandidateOffer findFirstCompatibleOffer(BaseCandidateOffer offer,
 CompatibleOfferNode node,
 List<BaseCandidateOffer> otherOffers)

checkCompatability

protected boolean checkCompatability(BaseCandidateOffer candidateOffer,
 BaseCandidateOffer otherCandidateOffer,
 CompatibleOfferNode node)

checkSegmentCombinable

protected boolean checkSegmentCombinable(BaseCandidateOffer offer,
 CompatibleOfferNode currentNode)

If this is an order offer and the segment is unique with the node path, then this offer can be combined.

checkForExplicitExclusions

protected boolean checkForExplicitExclusions(BaseCandidateOffer candidateOffer,
 BaseCandidateOffer otherCandidateOffer)

checkForStackable

protected boolean checkForStackable(BaseCandidateOffer candidateOffer,
 BaseCandidateOffer otherOffer)

checkForCombinable

protected boolean checkForCombinable(BaseCandidateOffer candidateOffer,
 BaseCandidateOffer otherOffer)

getCriteriaSetsByType

public List<Set<OfferCombinabilityCriteria>> getCriteriaSetsByType()

Builds a list consisting of the sets of OfferCombinabilityCriteria for each offer type. Each index in the list represents a level in the tree of possible offer combinations. The order is important as the permutations will first compute item offers which can impact the overall order subtotal and other offer eligibility. The list will only contain offer types that have relevant offers and they will be in the following order: Item, Order, Voucher, Fulfillment Item, Fulfillment Order

Returns:

addToListIfPresent

protected void addToListIfPresent(List<Set<OfferCombinabilityCriteria>> criteriaByTypeList,
 Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria> permutationMap)

Each element in the list represents a single offer type and the unique set of OfferCombinabilityCriteria objects. This structure supports the ability to find the best cross-type combination of offers.

Parameters:

criteriaByTypeList - The list to populate

permutationMap -

getBestOfferPermutation

public Optional<CombinedTypesOfferPermutation> getBestOfferPermutation()

updateBestCombinedTypesPermutation

public void updateBestCombinedTypesPermutation()

updateOfferNotAppliedResponses

public void updateOfferNotAppliedResponses(@NonNull
 com.broadleafcommerce.common.extension.TypeFactory offerFactory,
 @NonNull
 org.springframework.context.MessageSource messageSource)

copyBestPermutationCodeResponses

protected void copyBestPermutationCodeResponses()

isNotAppliedOffer

protected boolean isNotAppliedOffer(Set<Offer> appliedOffers,
 Offer offer)

getAppliedFulfillmentGroupOffers

protected Set<Offer> getAppliedFulfillmentGroupOffers()

getAppliedOrderOffers

protected Set<Offer> getAppliedOrderOffers()

getAppliedOrderItemOffers

protected Set<Offer> getAppliedOrderItemOffers()

getAppliedFulfillmentItemOffers

protected Set<Offer> getAppliedFulfillmentItemOffers()

createCodeResponse

protected com.broadleafcommerce.promotion.offer.client.web.context.discounts.CodeResponse createCodeResponse(OfferNotAppliedReasonEnum notUsedReason,
 @NonNull
 com.broadleafcommerce.common.extension.TypeFactory offerFactory,
 @NonNull
 org.springframework.context.MessageSource messageSource)

getItemProratedAdjustmentsMap

public Map<String,List<EnhancedProratedOfferAdjustment>> getItemProratedAdjustmentsMap()

getBestOrderAdjustmentsForTesting

public List<OrderOfferAdjustment> getBestOrderAdjustmentsForTesting()

Method facilitates unit testing. This method would not be reliable outside of tests as it does not properly null check the bestOfferPermutation

getOrderOfferCriteriaMap

public Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria> getOrderOfferCriteriaMap()

getItemOfferCriteriaMap

public Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria> getItemOfferCriteriaMap()

getFulfillmentGroupCriteriaMap

public Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria> getFulfillmentGroupCriteriaMap()

getFulfillmentItemCriteriaMap

public Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria> getFulfillmentItemCriteriaMap()

getVoucherCriteriaMap

public Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria> getVoucherCriteriaMap()

getCombinedTypesOfferPermutations

public List<CombinedTypesOfferPermutation> getCombinedTypesOfferPermutations()

isHasOffers

public boolean isHasOffers()

getOrder

public EnhancedOrder getOrder()

getCandidateOffers

public CandidateOffers getCandidateOffers()

setBestOfferPermutation

public void setBestOfferPermutation(CombinedTypesOfferPermutation bestOfferPermutation)