Uses of Class
com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

Packages that use BaseCandidateOffer

Package	Description
com.broadleafcommerce.promotion.offer.service.dto
com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper
com.broadleafcommerce.promotion.offer.service.engine.candidate

Uses of BaseCandidateOffer in com.broadleafcommerce.promotion.offer.service.dto

Classes in com.broadleafcommerce.promotion.offer.service.dto with type parameters of type BaseCandidateOffer

Modifier and Type	Class	Description
class	OffersPermutation<T extends BaseCandidateOffer>	DTO containing a set of compatible offers of the same type and that share the same combinability with regard to other types.

Subclasses of BaseCandidateOffer in com.broadleafcommerce.promotion.offer.service.dto

Modifier and Type	Class	Description
class	CandidateFulfillmentGroupOffer	DTO containing information necessary for determining if an Offer that can apply to one or more EnhancedFulfillmentGroups is part of the best permutation of all offers applicable to that group.
class	CandidateItemOffer	DTO containing information necessary for determining if an Offer that can apply to an EnhancedLineItem is part of the best permutation of all offers applicable to that line item.
class	CandidateOrderOffer	DTO containing information necessary for determining if an Offer that can apply to an EnhancedOrder is part of the best permutation of all offers applicable to that order.

Methods in com.broadleafcommerce.promotion.offer.service.dto that return BaseCandidateOffer

Modifier and Type	Method	Description
BaseCandidateOffer	OfferProcessingContext.findFirstCompatibleOffer(BaseCandidateOffer offer, CompatibleOfferNode node, List<BaseCandidateOffer> otherOffers)
BaseCandidateOffer	OfferProcessingContext.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

Methods in com.broadleafcommerce.promotion.offer.service.dto that return types with arguments of type BaseCandidateOffer

Modifier and Type	Method	Description
List<BaseCandidateOffer>	OfferProcessingContext.filterIncompatibleOffers(BaseCandidateOffer offer, CompatibleOfferNode node, List<BaseCandidateOffer> otherOffers)	Filters the passed in list, removing all incompatible offers
List<BaseCandidateOffer>	CandidateOffers.getAllCandidateOffers()	A set of all the relevant candidate offers for given offer engine execution
List<BaseCandidateOffer>	OfferCombinabilityCriteria.getCompatibleOffers()

Methods in com.broadleafcommerce.promotion.offer.service.dto with parameters of type BaseCandidateOffer

Modifier and Type	Method	Description
protected boolean	OfferProcessingContext.checkCompatability(BaseCandidateOffer candidateOffer, BaseCandidateOffer otherCandidateOffer, CompatibleOfferNode node)
protected boolean	OfferProcessingContext.checkForCombinable(BaseCandidateOffer candidateOffer, BaseCandidateOffer otherOffer)
protected boolean	OfferProcessingContext.checkForExplicitExclusions(BaseCandidateOffer candidateOffer, BaseCandidateOffer otherCandidateOffer)
protected boolean	OfferProcessingContext.checkForStackable(BaseCandidateOffer candidateOffer, BaseCandidateOffer otherOffer)
protected boolean	OfferProcessingContext.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.
List<BaseCandidateOffer>	OfferProcessingContext.filterIncompatibleOffers(BaseCandidateOffer offer, CompatibleOfferNode node, List<BaseCandidateOffer> otherOffers)	Filters the passed in list, removing all incompatible offers
BaseCandidateOffer	OfferProcessingContext.findFirstCompatibleOffer(BaseCandidateOffer offer, CompatibleOfferNode node, List<BaseCandidateOffer> otherOffers)
BaseCandidateOffer	OfferProcessingContext.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
void	CandidateOffers.initializeCandidateOfferForProcessing(BaseCandidateOffer offer, EnhancedOrder order)	Adds the offer to the relevant collections used by the offer engine.

Method parameters in com.broadleafcommerce.promotion.offer.service.dto with type arguments of type BaseCandidateOffer

Modifier and Type	Method	Description
void	OfferCombinabilityCriteria.addCompatibleOffers(List<? extends BaseCandidateOffer> offers)	Adds all offers of the same type that are compatible with this criteria to the compatibleOffers list.
void	OfferProcessingContext.createPathsForNode(CompatibleOfferNode currentNode, List<BaseCandidateOffer> theOffers, Set<CompatibleOfferNode> allNodes)
List<BaseCandidateOffer>	OfferProcessingContext.filterIncompatibleOffers(BaseCandidateOffer offer, CompatibleOfferNode node, List<BaseCandidateOffer> otherOffers)	Filters the passed in list, removing all incompatible offers
BaseCandidateOffer	OfferProcessingContext.findFirstCompatibleOffer(BaseCandidateOffer offer, CompatibleOfferNode node, List<BaseCandidateOffer> otherOffers)
BaseCandidateOffer	OfferProcessingContext.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 void	OfferProcessingContext.initializePermutations(List<? extends BaseCandidateOffer> offers, Map<OfferCombinabilityCriteriaKey,OfferCombinabilityCriteria> permutationMap)
void	CandidateOffers.setAllCandidateOffers(List<BaseCandidateOffer> allCandidateOffers)	A set of all the relevant candidate offers for given offer engine execution
void	OfferCombinabilityCriteria.setCompatibleOffers(List<BaseCandidateOffer> compatibleOffers)

Uses of BaseCandidateOffer in com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper

Methods in com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper with parameters of type BaseCandidateOffer

Modifier and Type	Method	Description
protected void	DefaultOrderAndItemOfferHelper.assertCandidateOfferNotNull(BaseCandidateOffer offer)
boolean	DefaultOrderAndItemOfferHelper.orderMeetsQualifyingTotalRequirements(BaseCandidateOffer candidateOffer)
boolean	OrderAndItemOfferHelper.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	DefaultOrderAndItemOfferHelper.orderMeetsSubtotalRequirements(EnhancedOrder order, BaseCandidateOffer candidateOffer)
boolean	OrderAndItemOfferHelper.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.

Uses of BaseCandidateOffer in com.broadleafcommerce.promotion.offer.service.engine.candidate

Methods in com.broadleafcommerce.promotion.offer.service.engine.candidate with type parameters of type BaseCandidateOffer

Modifier and Type	Method	Description
<T extends BaseCandidateOffer> List<T>	DefaultOfferCandidateService.filterOffersByItemQualifiers(@NonNull List<T> candidateOffers, @NonNull EnhancedOrder order)
<T extends BaseCandidateOffer> List<T>	OfferCandidateService.filterOffersByItemQualifiers(List<T> offerSet, EnhancedOrder order)	Filter the provided offer set based on if the items of the provided order match as qualifiers.

Methods in com.broadleafcommerce.promotion.offer.service.engine.candidate that return types with arguments of type BaseCandidateOffer

Modifier and Type	Method	Description
Optional<BaseCandidateOffer>	DefaultOfferCandidateService.constructCandidateOffer(Offer offer, EnhancedOrder order)
protected List<BaseCandidateOffer>	DefaultOfferCandidateService.expandOffersBySegment(BaseCandidateOffer offer, EnhancedOrder order)	It is possible for a single offer to be activated using two separate codes that are restricted to different segments.

Methods in com.broadleafcommerce.promotion.offer.service.engine.candidate with parameters of type BaseCandidateOffer

Modifier and Type	Method	Description
protected void	DefaultOfferCandidateService.addQualifiersToMap(BaseCandidateOffer candidateOffer, Map<ItemCriteriaRule,Collection<EnhancedLineItem>> itemCriteriaMap)
protected boolean	DefaultOfferCandidateService.evaluateOfferItemCriteriaAgainstOrder(@NonNull EnhancedOrder order, @NonNull BaseCandidateOffer offer, @NonNull Map<ItemCriteriaRule,Collection<EnhancedLineItem>> itemCriteriaMap, String connectiveOperator, boolean allowMatchesOnNonDiscountableItems)	Evaluates the ItemCriteriaRules from an order or order item targeting offer against the Order to determine whether the offer is applicable.
protected List<BaseCandidateOffer>	DefaultOfferCandidateService.expandOffersBySegment(BaseCandidateOffer offer, EnhancedOrder order)	It is possible for a single offer to be activated using two separate codes that are restricted to different segments.
void	DefaultOfferCandidateService.initializeWithCodeProperties(EnhancedOrder order, CandidateOffers candidateOffers, BaseCandidateOffer candidateOffer)
protected void	DefaultCandidateOfferUtility.populateCandidateOfferCurrency(@NonNull BaseCandidateOffer candidateOffer, @NonNull EnhancedOrder order, @NonNull Offer offer)	Populates the getCurrency() based on the given EnhancedOrder and Offer.
protected void	DefaultCandidateOfferUtility.populateOfferRoundingProperties(BaseCandidateOffer candidateOffer)	Populates offer rounding properties for order and item typed offers.
protected boolean	DefaultOfferCandidateService.shouldIncludeItem(EnhancedOrderLineItem item, EnhancedOrder order, BaseCandidateOffer offer)	Deprecated, for removal: This API element is subject to removal in a future version. Use DefaultOfferCandidateService.shouldIncludeItem(EnhancedOrderLineItem, EnhancedOrder, BaseCandidateOffer, boolean).
protected boolean	DefaultOfferCandidateService.shouldIncludeItem(EnhancedOrderLineItem item, EnhancedOrder order, BaseCandidateOffer offer, boolean allowMatchesOnNonDiscountableItems)	Whether the given EnhancedOrderLineItem should be considered when evaluating an ItemCriteriaRule.
protected boolean	DefaultOfferCandidateService.shouldIncludeOnSaleItem(EnhancedOrderLineItem item, BaseCandidateOffer candidateOffer)