Package com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper

Class DefaultOrderAndItemOfferHelper

java.lang.Object

com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

All Implemented Interfaces:

OrderAndItemOfferHelper

public class DefaultOrderAndItemOfferHelper
extends Object
implements OrderAndItemOfferHelper

Author:

Nathan Moore (nathanmoore).

Field Summary

Fields

Modifier and Type	Field	Description
protected com.broadleafcommerce.common.extension.TypeFactory	offerFactory
protected com.broadleafcommerce.rulesengine.expression.service.RuleEvaluationService	ruleEvaluationService

Constructor Summary

Constructors

Constructor	Description
DefaultOrderAndItemOfferHelper(com.broadleafcommerce.rulesengine.expression.service.RuleEvaluationService ruleEvaluationService, com.broadleafcommerce.common.extension.TypeFactory offerFactory)

Method Summary

Modifier and Type	Method	Description
protected void	assertCandidateOfferNotNull(BaseCandidateOffer offer)
protected int	calculateNumberOfTimesCriteriaIsMet(ItemCriteriaRule criteriaRule, Collection<EnhancedLineItem> lineItems)	Calculates and returns the total number of times the given EnhancedLineItems are met with the given ItemCriteriaRule.
com.broadleafcommerce.common.extension.TypeFactory	getOfferFactory()
com.broadleafcommerce.rulesengine.expression.service.RuleEvaluationService	getRuleEvaluationService()
Map<ItemCriteriaRule,Integer>	getTotalTimesCriteriaIsMetByCriteria(Map<ItemCriteriaRule,Collection<EnhancedLineItem>> itemsMetByCriteriaRule)	Gets a map of total number of times the ItemCriteriaRule is met by ItemCriteriaRule.
protected <P extends EnhancedLineItem> boolean	orderMeetsItemTotalRequirements(javax.money.MonetaryAmount minTotal, Map<ItemCriteriaRule,Collection<P>> candidateItemsMap, boolean useSalePrice)
boolean	orderMeetsQualifyingTotalRequirements(BaseCandidateOffer candidateOffer)	As offers are applied, recheck to ensure that the next offer in the collection of candidates can be applied based on the total of item qualifier prices.
boolean	orderMeetsSubtotalRequirements(EnhancedOrder order, BaseCandidateOffer candidateOffer)	As offers are applied, recheck to ensure that the next offer in the collection of candidates can be applied based on the order subtotal.
boolean	orderMeetsTargetTotalRequirements(CandidateItemOffer itemOffer)	As offers are applied, recheck to ensure that the next offer in the collection of candidates can be applied based on the total of target item prices.

Methods inherited from class java.lang.Object

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

Field Detail

ruleEvaluationService

protected final com.broadleafcommerce.rulesengine.expression.service.RuleEvaluationService ruleEvaluationService

offerFactory

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

Constructor Detail

DefaultOrderAndItemOfferHelper

public DefaultOrderAndItemOfferHelper(com.broadleafcommerce.rulesengine.expression.service.RuleEvaluationService ruleEvaluationService,
                                      com.broadleafcommerce.common.extension.TypeFactory offerFactory)

Method Detail

orderMeetsQualifyingTotalRequirements

public boolean orderMeetsQualifyingTotalRequirements(@NonNull
                                                     BaseCandidateOffer candidateOffer)

Description copied from interface: OrderAndItemOfferHelper

As offers are applied, recheck to ensure that the next offer in the collection of candidates can be applied based on the total of item qualifier prices.

Specified by:

orderMeetsQualifyingTotalRequirements in interface OrderAndItemOfferHelper

Parameters:

candidateOffer - candidate offer to verify that it can be applied based on the total of item qualifier prices.

Returns:

whether the offer can be applied based on the total of item qualifier prices.

orderMeetsTargetTotalRequirements

public boolean orderMeetsTargetTotalRequirements(@NonNull
                                                 CandidateItemOffer itemOffer)

Description copied from interface: OrderAndItemOfferHelper

As offers are applied, recheck to ensure that the next offer in the collection of candidates can be applied based on the total of target item prices.

Specified by:

orderMeetsTargetTotalRequirements in interface OrderAndItemOfferHelper

Parameters:

itemOffer - candidate offer to verify that it can be applied based on the total of target item prices.

Returns:

whether the offer can be applied based on the total of target item prices.

orderMeetsSubtotalRequirements

public boolean orderMeetsSubtotalRequirements(@NonNull
                                              EnhancedOrder order,
                                              @NonNull
                                              BaseCandidateOffer candidateOffer)

Description copied from interface: OrderAndItemOfferHelper

As offers are applied, recheck to ensure that the next offer in the collection of candidates can be applied based on the order subtotal.

Specified by:

orderMeetsSubtotalRequirements in interface OrderAndItemOfferHelper

Parameters:

order - EnhancedOrder against whose subtotal to verify the candidate offer's applicability

candidateOffer - candidate offer to verify that it can be applied based on the order subtotal.

Returns:

whether the offer can be applied based on the order subtotal.

getTotalTimesCriteriaIsMetByCriteria

public Map<ItemCriteriaRule,Integer> getTotalTimesCriteriaIsMetByCriteria(@NonNull
                                                                                Map<ItemCriteriaRule,Collection<EnhancedLineItem>> itemsMetByCriteriaRule)

Description copied from interface: OrderAndItemOfferHelper

Gets a map of total number of times the ItemCriteriaRule is met by ItemCriteriaRule.

Specified by:

getTotalTimesCriteriaIsMetByCriteria in interface OrderAndItemOfferHelper

Parameters:

itemsMetByCriteriaRule - a map of EnhancedLineItems that meet the ItemCriteriaRule

Returns:

a map of total number of times the ItemCriteriaRule is met by ItemCriteriaRule

calculateNumberOfTimesCriteriaIsMet

protected int calculateNumberOfTimesCriteriaIsMet(ItemCriteriaRule criteriaRule,
                                                  Collection<EnhancedLineItem> lineItems)

Calculates and returns the total number of times the given EnhancedLineItems are met with the given ItemCriteriaRule.

Parameters:

criteriaRule - the ItemCriteriaRule to get the ItemCriteriaRule.getNumberOfMatchesRequired() from

lineItems - the EnhancedLineItems to calculate the total number of times are met with the given ItemCriteriaRule

Returns:

the total number of times the given EnhancedLineItems are met with the given ItemCriteriaRule

getRuleEvaluationService

public com.broadleafcommerce.rulesengine.expression.service.RuleEvaluationService getRuleEvaluationService()

Specified by:

getRuleEvaluationService in interface OrderAndItemOfferHelper

Returns:

an instance of RuleEvaluationService.

getOfferFactory

public com.broadleafcommerce.common.extension.TypeFactory getOfferFactory()

Specified by:

getOfferFactory in interface OrderAndItemOfferHelper

Returns:

an instance of TypeFactory that creates offer domain objects

orderMeetsItemTotalRequirements

protected <P extends EnhancedLineItem> boolean orderMeetsItemTotalRequirements(javax.money.MonetaryAmount minTotal,
                                                                               Map<ItemCriteriaRule,Collection<P>> candidateItemsMap,
                                                                               boolean useSalePrice)

assertCandidateOfferNotNull

protected void assertCandidateOfferNotNull(BaseCandidateOffer offer)