Package org.broadleafcommerce.core.offer.service.processor

Class OrderOfferProcessorImpl

java.lang.Object

org.broadleafcommerce.core.offer.service.processor.AbstractBaseProcessor

org.broadleafcommerce.core.offer.service.processor.OrderOfferProcessorImpl

All Implemented Interfaces:

BaseProcessor, OrderOfferProcessor

Direct Known Subclasses:

FulfillmentGroupOfferProcessorImpl, ItemOfferProcessorImpl

@Service("blOrderOfferProcessor")
public class OrderOfferProcessorImpl
extends AbstractBaseProcessor
implements OrderOfferProcessor

Author:

jfischer, bpolster

Field Summary

Fields

Modifier and Type	Field	Description
protected org.broadleafcommerce.common.service.GenericEntityService	entityService
protected OfferDao	offerDao
protected OfferServiceUtilities	offerServiceUtilities
protected OrderItemDao	orderItemDao
protected PromotableItemFactory	promotableItemFactory

Fields inherited from class org.broadleafcommerce.core.offer.service.processor.AbstractBaseProcessor

extensionManager, offerTimeZoneProcessor, promotableOfferUtility

Constructor Summary

Constructors

Constructor	Description
OrderOfferProcessorImpl(PromotableOfferUtility promotableOfferUtility)

Method Summary

Modifier and Type	Method	Description
void	applyAllOrderOffers(List<PromotableCandidateOrderOffer> orderOffers, PromotableOrder promotableOrder)	Takes a list of sorted CandidateOrderOffers and determines if each offer can be applied based on the restrictions (stackable and/or combinable) on that offer.
protected void	applyOrderOffer(PromotableOrder promotableOrder, PromotableCandidateOrderOffer orderOffer)	Private method used by applyAllOrderOffers to create an OrderAdjustment from a CandidateOrderOffer and associates the OrderAdjustment to the Order.
protected String	buildItemPriceDetailKey(OrderItemPriceDetail itemDetail)
protected Map<Long,PromotableFulfillmentGroupAdjustment>	buildPromFulfillmentAdjMap(PromotableFulfillmentGroup fg)
protected Map<String,PromotableOrderItemPriceDetail>	buildPromotableDetailsMap(PromotableOrderItem item)
protected Map<Long,PromotableFulfillmentGroup>	buildPromotableFulfillmentGroupMap(PromotableOrder order)
protected Map<Long,PromotableOrderAdjustment>	buildPromotableOrderAdjustmentsMap(PromotableOrder promotableOrder)
protected Map<Long,PromotionQualifier>	buildPromotableQualifiersMap(PromotableOrderItem item)
protected void	compareAndAdjustOrderAndItemOffers(PromotableOrder promotableOrder)	Called when the system must determine whether to apply order or item adjustments.
boolean	couldOfferApplyToOrder(Offer offer, PromotableOrder promotableOrder)	Executes the appliesToOrderRules in the Offer to determine if this offer can be applied to the Order, OrderItem, or FulfillmentGroup.
protected boolean	couldOfferApplyToOrder(Offer offer, PromotableOrder promotableOrder, PromotableFulfillmentGroup fulfillmentGroup)	Private method which executes the appliesToOrderRules in the Offer to determine if this offer can be applied to the Order, OrderItem, or FulfillmentGroup.
protected boolean	couldOfferApplyToOrder(Offer offer, PromotableOrder promotableOrder, PromotableOrderItem orderItem)	Private method which executes the appliesToOrderRules in the Offer to determine if this offer can be applied to the Order, OrderItem, or FulfillmentGroup.
protected boolean	couldOfferApplyToOrder(Offer offer, PromotableOrder promotableOrder, PromotableOrderItem promotableOrderItem, PromotableFulfillmentGroup promotableFulfillmentGroup)	Private method which executes the appliesToOrderRules in the Offer to determine if this offer can be applied to the Order, OrderItem, or FulfillmentGroup.
protected PromotableCandidateOrderOffer	createCandidateOrderOffer(PromotableOrder promotableOrder, List<PromotableCandidateOrderOffer> qualifiedOrderOffers, Offer offer)
protected boolean	fgContainsFutureCreditAdjustment(FulfillmentGroup fg)
void	filterOrderLevelOffer(PromotableOrder promotableOrder, List<PromotableCandidateOrderOffer> qualifiedOrderOffers, Offer offer)
OfferServiceUtilities	getOfferServiceUtilities()
PromotableItemFactory	getPromotableItemFactory()
protected boolean	orderMeetsQualifyingSubtotalRequirements(PromotableOrder order, PromotableCandidateOrderOffer orderOffer)
protected boolean	orderMeetsSubtotalRequirements(PromotableOrder order, PromotableCandidateOrderOffer orderOffer)
protected void	processMatchingDetails(OrderItemPriceDetail itemDetail, PromotableOrderItemPriceDetail promotableItemDetail)
List<PromotableCandidateOrderOffer>	removeTrailingNotCombinableOrderOffers(List<PromotableCandidateOrderOffer> candidateOffers)
void	setOfferDao(OfferDao offerDao)	Set the offerDao (primarily for unit testing)
void	setOfferServiceUtilities(OfferServiceUtilities offerServiceUtilities)
void	setOrderItemDao(OrderItemDao orderItemDao)	Set the orderItemDao (primarily for unit testing)
void	setPromotableItemFactory(PromotableItemFactory promotableItemFactory)
protected void	syncFulfillmentPrice(FulfillmentGroup fg)
void	synchronizeAdjustmentsAndPrices(PromotableOrder promotableOrder)	Takes the adjustments and PriceDetails from the passed in PromotableOrder and transfers them to the actual order first checking to see if they already exist.
protected void	synchronizeFulfillmentGroupAdjustments(FulfillmentGroup fg, PromotableFulfillmentGroup promotableFG)
protected void	synchronizeFulfillmentGroups(PromotableOrder promotableOrder)
protected void	synchronizeItemPriceDetails(OrderItem orderItem, PromotableOrderItem promotableOrderItem)
protected void	synchronizeItemQualifiers(OrderItem orderItem, PromotableOrderItem promotableOrderItem)
protected void	synchronizeOrderAdjustments(PromotableOrder promotableOrder)
protected void	synchronizeOrderItems(PromotableOrder promotableOrder)
protected void	updateAdjustmentIfChangesDetected(OrderAdjustment adjustment, PromotableOrderAdjustment promotableAdjustment)

Methods inherited from class org.broadleafcommerce.core.offer.service.processor.AbstractBaseProcessor

addChildOrderItemsToCandidates, checkForItemRequirements, clearAllNonFinalizedQuantities, couldOfferApplyToCustomer, couldOfferApplyToOrderItems, couldOfferApplyToRequestDTO, couldOfferApplyToTimePeriod, couldOrderItemMeetOfferRequirement, dateToCalendar, executeExpression, filterOffers, finalizeQuantities, findQualifyingItemForPriceData, getOfferTimeZoneProcessor, hasPositiveValue, isEmpty, meetsItemQualifierSubtotal, removeInvalidCustomerOffers, removeInvalidRequestOffers, removeOutOfDateOffers, removeTimePeriodOffers, setOfferTimeZoneProcessor, splitDetailsIfNecessary, usePriceBeforeAdjustments

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.core.offer.service.processor.BaseProcessor

filterOffers

Methods inherited from interface org.broadleafcommerce.core.offer.service.processor.OrderOfferProcessor

executeExpression

Field Details

promotableItemFactory

protected PromotableItemFactory promotableItemFactory

orderItemDao

protected OrderItemDao orderItemDao

offerDao

protected OfferDao offerDao

offerServiceUtilities

protected OfferServiceUtilities offerServiceUtilities

entityService

protected org.broadleafcommerce.common.service.GenericEntityService entityService

Constructor Details

OrderOfferProcessorImpl

public OrderOfferProcessorImpl(PromotableOfferUtility promotableOfferUtility)

Method Details

filterOrderLevelOffer

public void filterOrderLevelOffer(PromotableOrder promotableOrder,
 List<PromotableCandidateOrderOffer> qualifiedOrderOffers,
 Offer offer)

Specified by:

filterOrderLevelOffer in interface OrderOfferProcessor

couldOfferApplyToOrder

public boolean couldOfferApplyToOrder(Offer offer,
 PromotableOrder promotableOrder)

Description copied from interface: OrderOfferProcessor

Executes the appliesToOrderRules in the Offer to determine if this offer can be applied to the Order, OrderItem, or FulfillmentGroup.

Specified by:

couldOfferApplyToOrder in interface OrderOfferProcessor

Returns:

true if offer can be applied, otherwise false

couldOfferApplyToOrder

protected boolean couldOfferApplyToOrder(Offer offer,
 PromotableOrder promotableOrder,
 PromotableOrderItem orderItem)

Private method which executes the appliesToOrderRules in the Offer to determine if this offer can be applied to the Order, OrderItem, or FulfillmentGroup.

Parameters:

offer -

promotableOrder -

orderItem -

Returns:

true if offer can be applied, otherwise false

couldOfferApplyToOrder

protected boolean couldOfferApplyToOrder(Offer offer,
 PromotableOrder promotableOrder,
 PromotableFulfillmentGroup fulfillmentGroup)

Private method which executes the appliesToOrderRules in the Offer to determine if this offer can be applied to the Order, OrderItem, or FulfillmentGroup.

Parameters:

offer -

promotableOrder -

fulfillmentGroup -

Returns:

true if offer can be applied, otherwise false

couldOfferApplyToOrder

protected boolean couldOfferApplyToOrder(Offer offer,
 PromotableOrder promotableOrder,
 PromotableOrderItem promotableOrderItem,
 PromotableFulfillmentGroup promotableFulfillmentGroup)

Private method which executes the appliesToOrderRules in the Offer to determine if this offer can be applied to the Order, OrderItem, or FulfillmentGroup.

Parameters:

offer -

promotableOrder -

promotableOrderItem -

promotableFulfillmentGroup -

Returns:

true if offer can be applied, otherwise false

createCandidateOrderOffer

protected PromotableCandidateOrderOffer createCandidateOrderOffer(PromotableOrder promotableOrder,
 List<PromotableCandidateOrderOffer> qualifiedOrderOffers,
 Offer offer)

removeTrailingNotCombinableOrderOffers

public List<PromotableCandidateOrderOffer> removeTrailingNotCombinableOrderOffers(List<PromotableCandidateOrderOffer> candidateOffers)

Specified by:

removeTrailingNotCombinableOrderOffers in interface OrderOfferProcessor

applyAllOrderOffers

public void applyAllOrderOffers(List<PromotableCandidateOrderOffer> orderOffers,
 PromotableOrder promotableOrder)

Description copied from interface: OrderOfferProcessor

Takes a list of sorted CandidateOrderOffers and determines if each offer can be applied based on the restrictions (stackable and/or combinable) on that offer. OrderAdjustments are create on the Order for each applied CandidateOrderOffer. An offer with stackable equals false cannot be applied to an Order that already contains an OrderAdjustment. An offer with combinable equals false cannot be applied to the Order if the Order already contains an OrderAdjustment.

Specified by:

applyAllOrderOffers in interface OrderOfferProcessor

Parameters:

orderOffers - a sorted list of CandidateOrderOffer

promotableOrder - the Order to apply the CandidateOrderOffers

orderMeetsQualifyingSubtotalRequirements

protected boolean orderMeetsQualifyingSubtotalRequirements(PromotableOrder order,
 PromotableCandidateOrderOffer orderOffer)

orderMeetsSubtotalRequirements

protected boolean orderMeetsSubtotalRequirements(PromotableOrder order,
 PromotableCandidateOrderOffer orderOffer)

compareAndAdjustOrderAndItemOffers

protected void compareAndAdjustOrderAndItemOffers(PromotableOrder promotableOrder)

Called when the system must determine whether to apply order or item adjustments.

Parameters:

promotableOrder -

applyOrderOffer

protected void applyOrderOffer(PromotableOrder promotableOrder,
 PromotableCandidateOrderOffer orderOffer)

Private method used by applyAllOrderOffers to create an OrderAdjustment from a CandidateOrderOffer and associates the OrderAdjustment to the Order.

Parameters:

orderOffer - a CandidateOrderOffer to apply to an Order

getPromotableItemFactory

public PromotableItemFactory getPromotableItemFactory()

Specified by:

getPromotableItemFactory in interface OrderOfferProcessor

setPromotableItemFactory

public void setPromotableItemFactory(PromotableItemFactory promotableItemFactory)

Specified by:

setPromotableItemFactory in interface OrderOfferProcessor

buildPromotableOrderAdjustmentsMap

protected Map<Long,PromotableOrderAdjustment> buildPromotableOrderAdjustmentsMap(PromotableOrder promotableOrder)

synchronizeOrderAdjustments

protected void synchronizeOrderAdjustments(PromotableOrder promotableOrder)

updateAdjustmentIfChangesDetected

protected void updateAdjustmentIfChangesDetected(OrderAdjustment adjustment,
 PromotableOrderAdjustment promotableAdjustment)

synchronizeOrderItems

protected void synchronizeOrderItems(PromotableOrder promotableOrder)

synchronizeItemPriceDetails

protected void synchronizeItemPriceDetails(OrderItem orderItem,
 PromotableOrderItem promotableOrderItem)

synchronizeItemQualifiers

protected void synchronizeItemQualifiers(OrderItem orderItem,
 PromotableOrderItem promotableOrderItem)

processMatchingDetails

protected void processMatchingDetails(OrderItemPriceDetail itemDetail,
 PromotableOrderItemPriceDetail promotableItemDetail)

buildItemPriceDetailKey

protected String buildItemPriceDetailKey(OrderItemPriceDetail itemDetail)

buildPromotableDetailsMap

protected Map<String,PromotableOrderItemPriceDetail> buildPromotableDetailsMap(PromotableOrderItem item)

buildPromotableQualifiersMap

protected Map<Long,PromotionQualifier> buildPromotableQualifiersMap(PromotableOrderItem item)

synchronizeFulfillmentGroups

protected void synchronizeFulfillmentGroups(PromotableOrder promotableOrder)

fgContainsFutureCreditAdjustment

protected boolean fgContainsFutureCreditAdjustment(FulfillmentGroup fg)

syncFulfillmentPrice

protected void syncFulfillmentPrice(FulfillmentGroup fg)

buildPromotableFulfillmentGroupMap

protected Map<Long,PromotableFulfillmentGroup> buildPromotableFulfillmentGroupMap(PromotableOrder order)

buildPromFulfillmentAdjMap

protected Map<Long,PromotableFulfillmentGroupAdjustment> buildPromFulfillmentAdjMap(PromotableFulfillmentGroup fg)

synchronizeFulfillmentGroupAdjustments

protected void synchronizeFulfillmentGroupAdjustments(FulfillmentGroup fg,
 PromotableFulfillmentGroup promotableFG)

synchronizeAdjustmentsAndPrices

public void synchronizeAdjustmentsAndPrices(PromotableOrder promotableOrder)

Description copied from interface: OrderOfferProcessor

Takes the adjustments and PriceDetails from the passed in PromotableOrder and transfers them to the actual order first checking to see if they already exist.

Specified by:

synchronizeAdjustmentsAndPrices in interface OrderOfferProcessor

setOfferDao

public void setOfferDao(OfferDao offerDao)

Description copied from interface: OrderOfferProcessor

Set the offerDao (primarily for unit testing)

Specified by:

setOfferDao in interface OrderOfferProcessor

setOrderItemDao

public void setOrderItemDao(OrderItemDao orderItemDao)

Description copied from interface: OrderOfferProcessor

Set the orderItemDao (primarily for unit testing)

Specified by:

setOrderItemDao in interface OrderOfferProcessor

getOfferServiceUtilities

public OfferServiceUtilities getOfferServiceUtilities()

setOfferServiceUtilities

public void setOfferServiceUtilities(OfferServiceUtilities offerServiceUtilities)