Package com.broadleafcommerce.promotion.offer.service

Class DefaultMarketingMessageResolver<P extends MarketingMessage,O extends Offer>

java.lang.Object

com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver<P,O>

All Implemented Interfaces:

MarketingMessageResolver<P,O>

public class DefaultMarketingMessageResolver<P extends MarketingMessage,O extends Offer>
extends Object
implements MarketingMessageResolver<P,O>

Author:

Jon Fleschler (jfleschler)

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTRIBUTES_ORDER_LINE_ITEM
protected MarketingMessageOfferCandidateService<O>	marketingMessageOfferCandidateService
protected MarketingMessageService<P>	marketingMessageService
protected OfferCandidateService<O>	offerCandidateService
protected com.broadleafcommerce.common.extension.TypeFactory	typeFactory

Constructor Summary

Constructors

Constructor	Description
DefaultMarketingMessageResolver(MarketingMessageService<P> marketingMessageService, OfferCandidateService<O> offerCandidateService, MarketingMessageOfferCandidateService<O> marketingMessageOfferCandidateService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected @NotNull MarketingMessageResponse<P>	buildMarketingMessageResponse(org.springframework.util.MultiValueMap<String,String> associatedOfferIds, List<P> messages, Integer maxResults)	Deprecated. deprecated as of 1.7, use buildMarketingMessageResponse(MultiValueMap, MultiValueMap, List, Integer) instead
protected @NotNull MarketingMessageResponse<P>	buildMarketingMessageResponse(org.springframework.util.MultiValueMap<String,String> associatedTargetProductOfferIds, org.springframework.util.MultiValueMap<String,String> associatedQualifierProductOfferIds, List<P> messages, Integer maxResults)
MarketingMessageResponse<P>	findAllMarketingMessagesForRequest(MarketingMessageRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Finds all of the MarketingMessages for the provided MarketingMessageRequest.
protected List<P>	findAllMessagesForItemAsQualifierOrTarget(MarketingMessageRequest request, Set<O> candidateOffers, org.springframework.util.MultiValueMap<String,String> associatedOfferIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. as of 1.7, use findAllMessagesForItemAsQualifierOrTarget(MarketingMessageRequest, Set, MultiValueMap, MultiValueMap, ContextInfo) instead
protected List<P>	findAllMessagesForItemAsQualifierOrTarget(MarketingMessageRequest request, Set<O> candidateOffers, org.springframework.util.MultiValueMap<String,String> associatedTargetProductOfferIds, org.springframework.util.MultiValueMap<String,String> associatedQualifierProductOfferIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find all marketing messages from offers where the line item is used either as the target of the offer, or used to qualify for the offer.
protected boolean	isItemOffer(Offer offer)	Checks if the Offer targets an order or fulfillment group item.
protected boolean	isItemQualifier(Offer offer, EnhancedLineItem item)	Checks if any of the rules in Offer.getItemQualifierCriteria() matches the line item on this request in order to determine if the line item can be used to qualify for the offer.
protected boolean	isItemTarget(Offer offer, EnhancedLineItem item)	If this is an item offer, checks if any of the rules in Offer.getTargetItemCriteria() matches the line item on this request in order to determine if the line item can be used as the target for the offer.
protected void	mergeProductMessageMaps(Map<String,List<P>> map, Map<String,P> productToMessageMap, Integer maxResults)
protected ItemCriteria	modifyItemCriteria(Offer offer, ItemCriteria itemCriteria)	In certain cases (i.e.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTES_ORDER_LINE_ITEM

public static final String ATTRIBUTES_ORDER_LINE_ITEM

See Also:

Constant Field Values

marketingMessageService

protected final MarketingMessageService<P extends MarketingMessage> marketingMessageService

offerCandidateService

protected final OfferCandidateService<O extends Offer> offerCandidateService

marketingMessageOfferCandidateService

protected final MarketingMessageOfferCandidateService<O extends Offer> marketingMessageOfferCandidateService

typeFactory

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

Constructor Detail

DefaultMarketingMessageResolver

public DefaultMarketingMessageResolver(MarketingMessageService<P> marketingMessageService,
                                       OfferCandidateService<O> offerCandidateService,
                                       MarketingMessageOfferCandidateService<O> marketingMessageOfferCandidateService,
                                       com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Detail

findAllMarketingMessagesForRequest

public MarketingMessageResponse<P> findAllMarketingMessagesForRequest(MarketingMessageRequest request,
                                                                      @Nullable
                                                                      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: MarketingMessageResolver

Finds all of the MarketingMessages for the provided MarketingMessageRequest. This will find all the active Offers first, then split them into two, filtered groups: Those that treat the MarketingMessageRequest.getLineItems() as a target and those that treat it as a qualifier. Then, it will fetch all messages for those offers, grouping by MarketingMessageLocationType, filter by active date range and sort them by priority.

Specified by:

findAllMarketingMessagesForRequest in interface MarketingMessageResolver<P extends MarketingMessage,O extends Offer>

Parameters:

request - an MarketingMessageRequest containing the parameters by which the results will be filtered

contextInfo - the context information around sandboxing and multitenant state

Returns:

the marketing messages for the given item in priority order

buildMarketingMessageResponse

@NotNull
@Deprecated
protected @NotNull MarketingMessageResponse<P> buildMarketingMessageResponse(org.springframework.util.MultiValueMap<String,String> associatedOfferIds,
                                                                             List<P> messages,
                                                                             Integer maxResults)

Deprecated.

deprecated as of 1.7, use buildMarketingMessageResponse(MultiValueMap, MultiValueMap, List, Integer) instead

buildMarketingMessageResponse

@NotNull
protected @NotNull MarketingMessageResponse<P> buildMarketingMessageResponse(org.springframework.util.MultiValueMap<String,String> associatedTargetProductOfferIds,
                                                                             org.springframework.util.MultiValueMap<String,String> associatedQualifierProductOfferIds,
                                                                             List<P> messages,
                                                                             Integer maxResults)

mergeProductMessageMaps

protected void mergeProductMessageMaps(Map<String,List<P>> map,
                                       Map<String,P> productToMessageMap,
                                       Integer maxResults)

findAllMessagesForItemAsQualifierOrTarget

@Deprecated
protected List<P> findAllMessagesForItemAsQualifierOrTarget(MarketingMessageRequest request,
                                                            Set<O> candidateOffers,
                                                            org.springframework.util.MultiValueMap<String,String> associatedOfferIds,
                                                            @Nullable
                                                            com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated.

as of 1.7, use findAllMessagesForItemAsQualifierOrTarget(MarketingMessageRequest, Set, MultiValueMap, MultiValueMap, ContextInfo) instead

findAllMessagesForItemAsQualifierOrTarget

protected List<P> findAllMessagesForItemAsQualifierOrTarget(MarketingMessageRequest request,
                                                            Set<O> candidateOffers,
                                                            org.springframework.util.MultiValueMap<String,String> associatedTargetProductOfferIds,
                                                            org.springframework.util.MultiValueMap<String,String> associatedQualifierProductOfferIds,
                                                            @Nullable
                                                            com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Find all marketing messages from offers where the line item is used either as the target of the offer, or used to qualify for the offer.

Parameters:

request - an MarketingMessageRequest containing the parameters by which the results will be filtered

candidateOffers - the candidate offers to filter on

associatedTargetProductOfferIds - map of associated offers to target product id

associatedQualifierProductOfferIds - map of associated offers to qualifier product id

contextInfo - Context information around sandbox and multitenant state.

Returns:

the list of marketing messages that qualify based on the associated offers and message type.

isItemOffer

protected boolean isItemOffer(Offer offer)

Checks if the Offer targets an order or fulfillment group item.

Parameters:

offer - the Offer to check

Returns:

true if the offer targets an order or fulfillment group item

isItemQualifier

protected boolean isItemQualifier(Offer offer,
                                  EnhancedLineItem item)

Checks if any of the rules in Offer.getItemQualifierCriteria() matches the line item on this request in order to determine if the line item can be used to qualify for the offer.

Parameters:

offer - the Offer to check

item - the EnhancedLineItem to check

Returns:

true if a match is found in the qualifier criteria

isItemTarget

protected boolean isItemTarget(Offer offer,
                               EnhancedLineItem item)

If this is an item offer, checks if any of the rules in Offer.getTargetItemCriteria() matches the line item on this request in order to determine if the line item can be used as the target for the offer. If the offer discount cannot apply to the sales price and the line item is on sale, then the item will not qualify as the offer target.

Parameters:

offer - the Offer to check

item - the EnhancedLineItem to check

Returns:

true if the line item can qualify as the target of the offer

modifyItemCriteria

protected ItemCriteria modifyItemCriteria(Offer offer,
                                          @Nullable
                                          ItemCriteria itemCriteria)

In certain cases (i.e. Fulfillment Group Item Offers) we need modify the rules so that they can be evaluated.

Parameters:

offer - the Offer to check

itemCriteria - the ItemCriteria to modify

Returns:

the potentially modified item criteria