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

Interface OrderAndItemOfferHelper

All Known Implementing Classes:

DefaultOrderAndItemOfferHelper

public interface OrderAndItemOfferHelper

This class contains methods with usage shared by ItemOfferProcessor and OrderOfferProcessor.

Author:

Nathan Moore (nathanmoore).

Method Summary

Modifier and Type	Method	Description
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.
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.

Method Detail

orderMeetsQualifyingTotalRequirements

boolean orderMeetsQualifyingTotalRequirements(@NonNull
                                              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.

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

boolean orderMeetsTargetTotalRequirements(@NonNull
                                          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.

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

boolean orderMeetsSubtotalRequirements(@NonNull
                                       EnhancedOrder order,
                                       @NonNull
                                       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.

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

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

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

Parameters:

itemsMetByCriteriaRule - a map of EnhancedLineItems that meet the ItemCriteriaRule

Returns:

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

getRuleEvaluationService

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

Returns:

an instance of RuleEvaluationService.

getOfferFactory

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

Returns:

an instance of TypeFactory that creates offer domain objects