Package com.broadleafcommerce.promotion.offer.service

Interface MarketingMessageService<P extends MarketingMessage>

All Superinterfaces:

com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>

All Known Implementing Classes:

DefaultMarketingMessageService

public interface MarketingMessageService<P extends MarketingMessage>
extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>

Base service API for MarketingMessage. Backed by a MarketingMessageRepository.

Author:

Nathan Moore (nathanmoore).

Method Summary

Modifier and Type	Method	Description
String	getRepositoryDomain()
org.springframework.data.domain.Page<P>	readAllActiveByOfferIds(Collection<String> offerIds, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageInfo, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<P>	readAllActiveByQualifierAndTargetOffersAndRequest(Set<String> qualifierOfferIds, Set<String> targetOfferIds, ItemMarketingMessageRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. since 1.6, use readAllActiveByQualifierAndTargetOffersAndRequest(Set, Set, MarketingMessageRequest, ContextInfo) instead
List<P>	readAllActiveByQualifierAndTargetOffersAndRequest(Set<String> qualifierOfferIds, Set<String> targetOfferIds, MarketingMessageRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Finds marketing messages for the given offers.
org.springframework.data.domain.Page<P>	readAllByOfferId(String offerId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageInfo, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.CrudEntityService

create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByContextId, readByContextId, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess, updateSort

Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService

readAll, readAll, readAll, readAll

Method Detail

readAllByOfferId

org.springframework.data.domain.Page<P> readAllByOfferId(String offerId,
                                                         @Nullable
                                                         cz.jirutka.rsql.parser.ast.Node filters,
                                                         @Nullable
                                                         org.springframework.data.domain.Pageable pageInfo,
                                                         @Nullable
                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAllActiveByOfferIds

org.springframework.data.domain.Page<P> readAllActiveByOfferIds(Collection<String> offerIds,
                                                                @Nullable
                                                                cz.jirutka.rsql.parser.ast.Node filters,
                                                                @Nullable
                                                                org.springframework.data.domain.Pageable pageInfo,
                                                                @Nullable
                                                                com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAllActiveByQualifierAndTargetOffersAndRequest

@Deprecated
List<P> readAllActiveByQualifierAndTargetOffersAndRequest(Set<String> qualifierOfferIds,
                                                          Set<String> targetOfferIds,
                                                          ItemMarketingMessageRequest request,
                                                          @Nullable
                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated.

since 1.6, use readAllActiveByQualifierAndTargetOffersAndRequest(Set, Set, MarketingMessageRequest, ContextInfo) instead

Finds marketing messages for the given offers and locale, filtering such that locationType match any of the given values.

Parameters:

qualifierOfferIds - the ids of offers where the messages should be associated with the items that qualify.

targetOfferIds - the ids of offers where the messages should be associated with the items that are targeted by the offer.

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

contextInfo - the context around sandboxing and multitenant state

Returns:

the marketing messages matching the given criteria

readAllActiveByQualifierAndTargetOffersAndRequest

List<P> readAllActiveByQualifierAndTargetOffersAndRequest(Set<String> qualifierOfferIds,
                                                          Set<String> targetOfferIds,
                                                          MarketingMessageRequest request,
                                                          @Nullable
                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Finds marketing messages for the given offers.

Parameters:

qualifierOfferIds - the ids of offers where the messages should be associated with the items that qualify.

targetOfferIds - the ids of offers where the messages should be associated with the items that are targeted by the offer.

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

contextInfo - the context around sandboxing and multitenant state

Returns:

the marketing messages matching the given criteria

getRepositoryDomain

String getRepositoryDomain()