A B C D E F G H I J L M N O P Q R S T U V W Z
All Classes All Packages

A

account - Variable in class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

Name of the field passed in as part of UserTarget.targetType that maps to the account.

ACCOUNT - com.broadleafcommerce.promotion.offer.domain.type.UserMaxUsesStrategyType

The Offer.maxUsesPerUser will be determined based on how many times a provided user of UserTarget.targetType "account" has used the offer

ADD_TO_CART_RESPONSE - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Means that the marketing message should be returned with the add to cart response.

addAdjustment(FulfillmentGroupAdjustment) - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

addAdjustment(OrderOfferAdjustment) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderOfferPermutationResult

addAdjustmentToFulfillmentGroup(CandidateFulfillmentGroup, FulfillmentGroupAdjustment) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

addCartSubtotalCriteria(List<Predicate>, CriteriaBuilder, Root<JpaMarketingMessage>, Map<String, Object>, MarketingMessageRequest) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

addChildNode(CompatiblePermutationNode) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

addChildrenForItem(EnhancedOrderLineItem, Collection<EnhancedOrderLineItem>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

addCodeUsages(List<? extends Offer>, CodeUsabilityInfo, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

addCompatibleOffers(List<? extends BaseCandidateOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

Adds all offers of the same type that are compatible with this criteria to the compatibleOffers list.

addCompatibleOffers(List<BaseCandidateOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteriaKey

Adds all offers of the same type that are compatible with this criteria to the compatibleOffers list.

addFreeGiftItem(FreeGiftItem, MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

addFreeGiftsToResult(OfferProcessingContext, ItemOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

addLocaleCriteria(List<Predicate>, CriteriaBuilder, Root<JpaMarketingMessage>, Map<String, Object>, ItemMarketingMessageRequest) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

Adds the locale criteria to the Criteria.

addNewCandidateFG(CandidateFulfillmentGroupOffer, EnhancedFulfillmentGroup) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

addNewCandidateFG(CandidateFulfillmentGroupOffer, EnhancedFulfillmentGroup, Map<ItemCriteriaRule, Collection<EnhancedFulfillmentLineItem>>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

addNewQualifierAndGet(TypeFactory, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

addNewTargetAndGet(TypeFactory, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

addNodes(CompatiblePermutationNode, OfferProcessingContext, List<Set<OfferCombinabilityCriteria>>, LinkedHashSet<CompatiblePermutationNode>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.OfferProcesingUtility

addOfferAppliedCriteria(List<Predicate>, CriteriaBuilder, Root<JpaMarketingMessage>, Map<String, Object>, MarketingMessageRequest) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

addOrderCodeToAdjustmentIfUsed(Offer, Adjustment, Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Adds an offer code to the given Adjustment if it is present on the order.

addOrderCodeToAdjustmentIfUsed(Offer, Adjustment, Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineResponseBuilder

Adds an offer code to the given Adjustment if it is present on the order.

addOrUpdateMatchingOfferQualifier(CandidateItemOffer, ItemCriteriaRule, int, TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Either creates a new OfferQualifier or updates a preexisting one for the given CandidateItemOffer, marking the quantity of to reserve for use as qualifiers for the given ItemCriteriaRule.

addOrUpdateMatchingOfferTarget(CandidateItemOffer, ItemCriteriaRule, int, TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Either creates a new OfferDiscount or updates a preexisting one for the given CandidateItemOffer, marking the quantity of to reserve for use as targets for the given ItemCriteriaRule.

addPermutation(String, Set<OffersPermutation>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

addProratedItemOfferAdjustmentsToParentOfferDetails(Collection<? extends EnhancedProratedItemOfferAdjustment>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

addProratedItemOfferAdjustmentsToParentOfferDetails(Collection<? extends EnhancedProratedItemOfferAdjustment>) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.proration.ProrationService

Adds the ProratedItemOfferAdjustments to their parent LineItemOfferDetails

addQualifierOfferIdsCriteria(Collection<String>, CriteriaBuilder, Root<JpaMarketingMessage>, Map<String, Object>, List<Predicate>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

addQualifiersToMap(BaseCandidateOffer, Map<ItemCriteriaRule, Collection<EnhancedLineItem>>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

addSelfToParentDetail() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

addTargetOfferIdsCriteria(Collection<String>, CriteriaBuilder, Root<JpaMarketingMessage>, Map<String, Object>, List<Predicate>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

addToListIfPresent(List<Set<OfferCombinabilityCriteria>>, Map<OfferCombinabilityCriteriaKey, OfferCombinabilityCriteria>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

Each element in the list represents a single offer type and the unique set of OfferCombinabilityCriteria objects.

addVoucher(Voucher, MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderOfferPermutationResult

addVoucherToResult(OfferProcessingContext, OrderOfferPermutationResult, CandidateOrderOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

Adds Voucher to the given EnhancedOrder based on the given voucher offer.

adjustedTotal - Variable in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Adjustment() - Constructor for class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.Adjustment

ADJUSTMENTS_PATH - Static variable in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

adjustTotals(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

Update subtotals and adjusted subtotals.

adjustTotalValue(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

Total value can be adjusted by items that aren't part of the normal adjustments like vouchers

afterPropertiesSet() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

afterPropertiesSet() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferAuditDetailRepository

afterPropertiesSet() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferRepository

amount - Variable in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

The discount amount that this tier represents.

amount - Variable in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

AMOUNT_OFF - com.broadleafcommerce.promotion.offer.domain.type.DiscountMethodType

Take an amount off of the total amount.

ANY - com.broadleafcommerce.promotion.offer.domain.type.CombinabilityType

A.K.A, combinable.

APPLICATION_ID_PATH - Static variable in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

applyAdjustments(OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

applyAdjustments(OfferProcessingContext) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.OfferApplicationService

Applies the adjustments to the EnhancedOrder and returns the order with adjustments applied and totals updated.

applyAdjustments(EnhancedOrder, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

applyAdjustments(EnhancedOrder, OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

applyAdjustments(EnhancedOrder, OfferProcessingContext) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.OfferEngineService

Applies the offers to the order in a way that gives the best discount for the customer based on possible permutations.

applyCandidateOffers(EnhancedOrder, List<CandidateItemOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

applyFreeGift(EnhancedOrder, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Builds and adds a FreeGiftItem to EnhancedOrder.getFreeGiftItems() based on CandidateItemOffer.getCandidateQualifiersMap() if the given itemOffer is a free gift offer.

applyFulfillmentGroupAdjustments(OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

applyFulfillmentGroupAdjustments(OfferProcessingContext, Map<String, List<FulfillmentGroupAdjustment>>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

applyFulfillmentGroupAdjustments(OfferProcessingContext, Map<String, List<FulfillmentGroupAdjustment>>) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.FulfillmentGroupOfferProcessor

applyFulfillmentItemAdjustments(OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

applyItemAdjustments(OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

applyItemAdjustments(OfferProcessingContext, ItemOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

applyItemAdjustments(OfferProcessingContext, ItemOfferPermutationResult) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.ItemOfferProcessor

For item processing, the adjustments are stored on LineItemOfferDetail records.

applyItemOffer(EnhancedOrder, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

applyItemQualifiersAndTargets(EnhancedOrder, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

applyLineItemAdjustment(CandidateItemOffer, LineItemOfferDetail, OfferDiscount) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Adds an ItemOfferAdjustment to the given LineItemOfferDetail.

applyOfferAdjustments(OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

applyOffers(HttpServletRequest, ContextInfo, EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

applyOrderAdjustments(OfferProcessingContext, OrderOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

applyOrderAdjustments(OfferProcessingContext, OrderOfferPermutationResult) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.OrderOfferProcessor

assertCandidateOfferNotNull(BaseCandidateOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

assertCandidateOfferNotNull(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

assertCandidateOfferNotNull(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

assertCandidateOffersNotNull(CandidateOffers) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

assertCommonParamsNotNull(EnhancedOrder, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

assertCommonParamsNotNull(EnhancedOrder, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

assertCommonParamsNotNull(EnhancedOrder, CandidateOffers) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

assertOfferExistsAndReturn(String, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

assertOfferIdNotNull(String) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferAuditDetailService

assertOfferNotNull(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

assertOrderNotNull(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

assertParentOfferOfMessageIsCorrect(String, MarketingMessage) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

Attribute - Class in com.broadleafcommerce.promotion.offer.domain

Many entities have customizable dynamic attributes, and this class is intended to hold such values.

Attribute() - Constructor for class com.broadleafcommerce.promotion.offer.domain.Attribute

Attribute(Object, EmbeddedContextState) - Constructor for class com.broadleafcommerce.promotion.offer.domain.Attribute

AttributeMapConverter - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain.support

Transforms a Map of String keys and JpaAttribute values into a JSON object String and vice versa.

AttributeMapConverter(ObjectMapper) - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.support.AttributeMapConverter

ATTRIBUTES_ORDER_LINE_ITEM - Static variable in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

auditService - Variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

auditService - Variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

auditService - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

B

BadOrderDataException - Exception in com.broadleafcommerce.promotion.offer.web.endpoint.exception

BadOrderDataException(String) - Constructor for exception com.broadleafcommerce.promotion.offer.web.endpoint.exception.BadOrderDataException

BASE_URI - Static variable in class com.broadleafcommerce.promotion.offer.web.endpoint.ItemMarketingMessageRetrievalEndpoint

Deprecated.

BASE_URI - Static variable in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessageRetrievalEndpoint

BASE_URI - Static variable in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

BASE_URI - Static variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferAuditDetailsEndpoint

BASE_URI - Static variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

BASE_URI - Static variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

BaseCandidateOffer - Class in com.broadleafcommerce.promotion.offer.service.dto

BaseCandidateOffer() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

BROWSE - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Means that the marketing message should appear on browse / search (list) pages only separate from the product listing.

BROWSE_ITEM - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Means that the marketing message should appear next to applicable items on browse (list) pages only.

build(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineResponseBuilder

build(EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.OfferEngineResponseBuilder

Builds a response object detailing the adjustment information on the provided order.

buildAdjustmentForFreeGift(EnhancedOrder, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Builds an Adjustment for a FreeGiftItem.

buildAutomaticOrCodeOrCustomerOffersPredicate(Iterable<? extends UserTarget>, Iterable<String>, Iterable<String>, CriteriaQuery<JpaOffer>, CriteriaBuilder, Root<JpaOffer>, Map<String, Object>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferRepository

buildCombinedOfferTypePermutations(EnhancedOrder, OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.OfferProcesingUtility

Each offer type (e.g.

buildContextInfo(String, String) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

Builds a ContextInfo for the application context id and tenant id

buildDetailKey() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

buildFreeGiftItem(Offer, int, Adjustment) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Builds a FreeGiftItem from the given Offer, quantity, and qualifier item ids.

buildMarketingMessageResponse(MultiValueMap<String, String>, List<P>, Integer) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

Deprecated.

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

buildMarketingMessageResponse(MultiValueMap<String, String>, MultiValueMap<String, String>, List<P>, Integer) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

buildOfferAuditDetail(String, RecordOfferUsageEventListener.Adjustment) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

Builds the OfferAuditDetail for the used offer code

buildOfferDetailList(Collection<? extends EnhancedLineItem>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

buildOfferPermutationsForCriteria(OfferCombinabilityCriteria) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

This method builds all compatible permutations of offers in a tree structure.

buildOrderItemHierarchies() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

buildResponse(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

buildSharedCodesSubquery(CriteriaQuery<JpaOffer>, CriteriaBuilder) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferRepository

buildTrackingSubquery(CriteriaQuery<JpaOffer>, CriteriaBuilder) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferRepository

buildUserTarget(String) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

Build the UserTarget associated with the Offer Code's use

buildUserTargetsForCustomerContext(CustomerContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

buildUserTargetsForCustomerContext(CustomerContext) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferUserService

Build and return a list of UserTargets based on the information provided in the CustomerContext.

buildUserTargetSubquery(CriteriaQuery<JpaOffer>, CriteriaBuilder, int) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferRepository

buildVoucher(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

C

CACHE_BY_AUTOMATIC - Static variable in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

CACHE_BY_USER_TARGETS - Static variable in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

CACHE_BY_VOUCHER - Static variable in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

calculateAdjustmentValue(CurrencyUnit, boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

calculateDiscountForItem(CandidateItemOffer, EnhancedLineItem, int) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

calculateDiscountForItem(CandidateItemOffer, EnhancedLineItem, int) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.PotentialSavingsCalculator

Calculates the potential discount of a CandidateItemOffer for an EnhancedLineItem.

calculateItemAdjustmentsTotal(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

calculateItemAdjustmentsValue(boolean, boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

calculateItemUnitPriceWithAdjustments(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

calculateNumberOfTimesCriteriaIsMet(ItemCriteriaRule, Collection<EnhancedLineItem>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

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

calculateOrderAdjustmentTotal() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

calculateOrderFutureCredits() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

calculatePotentialSavings() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

calculatePotentialSavings(EnhancedOrder, List<CandidateFulfillmentGroupOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

calculatePotentialSavings(EnhancedOrder, List<CandidateItemOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

calculatePotentialSavingsForOffer(EnhancedOrder, CandidateItemOffer, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

calculatePotentialSavingsForOffer(EnhancedOrder, CandidateItemOffer, boolean) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.PotentialSavingsCalculator

Calculates the TotalPotentialSavings for all of the given EnhancedOrder.getOrderLineItems() order's order line items} if the given CandidateItemOffer was applied.

calculatePriceForBundleRatio(LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

calculatePriceWithoutAdjustments() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

Calculate and return the price for this EnhancedFulfillmentGroup without any adjustments added.

calculateProratedAmount(ItemOfferAdjustment, int) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

calculateProratedItemAdjustments(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

calculateProratedItemAdjustments(EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.proration.ProrationService

For any Offer that has a Discount.prorationType of ProrationType.TARGET_AND_QUALIFIER, this will populate all of the ProratedItemOfferAdjustments on the LineItemOfferDetails mostly for the sake of reporting instruments.

calculateProrationItemAdjustment(ItemOfferAdjustment) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

calculateSaleAdjustmentUnitPrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

calculateSimplePercent(MonetaryAmount, MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

calculateStandardAdjustmentUnitPrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

calculateSubtotalWithAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

calculateSubtotalWithAdjustments(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

calculateSubtotalWithoutAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

calculateTargetAmountForTieredOffer() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

calculateTargetQuantityForTieredOffer() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Determines the number of target order items that can be used when determining which discount tier to use in discounts.

calculateTotalAdjustmentValue(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

calculateTotalAdjustmentValue(CurrencyUnit, boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

calculateTotalWithAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

calculateWeightedPercent(EnhancedLineItem, MonetaryAmount, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

canApplyOffer(CandidateFulfillmentGroupOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Whether the provided offer can be applied to this group.

CandidateFulfillmentGroup - Class in com.broadleafcommerce.promotion.offer.service.dto

Represents a candidate fulfillment group for which an Offer has been applied.

CandidateFulfillmentGroup() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

CandidateFulfillmentGroupOffer - Class in com.broadleafcommerce.promotion.offer.service.dto

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.

CandidateFulfillmentGroupOffer() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

CandidateItemOffer - Class in com.broadleafcommerce.promotion.offer.service.dto

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.

CandidateItemOffer() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

CandidateItemOfferComparator - Class in com.broadleafcommerce.promotion.offer.service.dto.comparator

CandidateItemOfferComparator() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.comparator.CandidateItemOfferComparator

CandidateOffers - Class in com.broadleafcommerce.promotion.offer.service.dto

DTO containing the candidate offers broken out into groups based on an offer's Discount.getTargetType() }.

CandidateOffers() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

candidateOfferUtility - Variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

candidateOfferUtility() - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

CandidateOfferUtility - Interface in com.broadleafcommerce.promotion.offer.service.engine.candidate

Utility for creating each of the different CandidateXOffer types: CandidateOrderOffer, CandidateItemOffer, CandidateFulfillmentGroupOffer.

CandidateOrderOffer - Class in com.broadleafcommerce.promotion.offer.service.dto

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.

CandidateOrderOffer() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.cache.OfferCacheProperties

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.Attribute

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessages

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.SharedCode

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.UserTarget

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaAttribute

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTracking

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTrackingId

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverrideId

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaItemCriteriaRule

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCodeId

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTargetId

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.QualifierLineItemOfferDetailComparator

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.Adjustment

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.OfferRef

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentLineItem

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

canEqual(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

canOfferBeApplied(EnhancedOrder, CandidateItemOffer, List<LineItemOfferDetail>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Determines whether the Offer can be applied by making sure it is combinable and that all other offers applied to any LineItems are also combinable by checking their EnhancedLineItem.offerDetails.

canUseOrderLineItemsAsQualifiers(String) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

canUserUseOffer(Offer, CustomerContext, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

canUserUseOffer(Offer, CustomerContext, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferUserService

For the provided customer information, check if there are no more usages for the provided offer available.

CART - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Means that the marketing message should appear on the cart page separate from the cart item.

CART_ID_PATH - Static variable in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

CART_ITEM - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Means that the marketing message should appear next to applicable items in the cart summary only.

CHANNEL - Static variable in interface com.broadleafcommerce.promotion.offer.service.messaging.checkout.OfferCheckoutCompletionConsumer

CHEAPEST - com.broadleafcommerce.promotion.offer.domain.type.TargetGroupingStrategy

Items are grouped in a way where discounts are applied to the cheapest items.

checkCompatability(BaseCandidateOffer, BaseCandidateOffer) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

checkForCombinable(BaseCandidateOffer, BaseCandidateOffer) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

checkForExplicitExclusions(BaseCandidateOffer, BaseCandidateOffer) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

checkForStackable(BaseCandidateOffer, BaseCandidateOffer) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

checkoutCompletionInputOffer() - Method in interface com.broadleafcommerce.promotion.offer.service.messaging.checkout.OfferCheckoutCompletionConsumer

checkStackable(Offer, Offer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

chooseSaleOrStandardAdjustments(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Some Offers can only apply to the EnhancedLineItem.getStandardPrice().

chooseSaleOrStandardPrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

This method will check to see if the salePriceAdjustments or standardPriceAdjustments are better and remove those that should not apply.

chooseUnadjustedSaleOrStandardPrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

cleanMethodType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

clearAllNonFinalizedQuantities() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Clears target and qualifier quantities that were marked for a promotion that did not have enough qualifiers or targets to get applied.

clearAllNonFinalizedQuantities(List<LineItemOfferDetail>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

clearState() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

clearStateBetweenPermutations(EnhancedOrder, List<CandidateFulfillmentGroupOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

clearStateBetweenPermutations(EnhancedOrder, List<CandidateItemOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

com.broadleafcommerce.promotion.offer.autoconfigure - package com.broadleafcommerce.promotion.offer.autoconfigure

com.broadleafcommerce.promotion.offer.cache - package com.broadleafcommerce.promotion.offer.cache

com.broadleafcommerce.promotion.offer.domain - package com.broadleafcommerce.promotion.offer.domain

com.broadleafcommerce.promotion.offer.domain.type - package com.broadleafcommerce.promotion.offer.domain.type

com.broadleafcommerce.promotion.offer.provider - package com.broadleafcommerce.promotion.offer.provider

com.broadleafcommerce.promotion.offer.provider.jpa - package com.broadleafcommerce.promotion.offer.provider.jpa

com.broadleafcommerce.promotion.offer.provider.jpa.autoconfigure - package com.broadleafcommerce.promotion.offer.provider.jpa.autoconfigure

com.broadleafcommerce.promotion.offer.provider.jpa.domain - package com.broadleafcommerce.promotion.offer.provider.jpa.domain

com.broadleafcommerce.promotion.offer.provider.jpa.domain.support - package com.broadleafcommerce.promotion.offer.provider.jpa.domain.support

com.broadleafcommerce.promotion.offer.provider.jpa.environment - package com.broadleafcommerce.promotion.offer.provider.jpa.environment

com.broadleafcommerce.promotion.offer.provider.jpa.repository - package com.broadleafcommerce.promotion.offer.provider.jpa.repository

com.broadleafcommerce.promotion.offer.repository - package com.broadleafcommerce.promotion.offer.repository

com.broadleafcommerce.promotion.offer.service - package com.broadleafcommerce.promotion.offer.service

com.broadleafcommerce.promotion.offer.service.autoconfigure - package com.broadleafcommerce.promotion.offer.service.autoconfigure

com.broadleafcommerce.promotion.offer.service.dto - package com.broadleafcommerce.promotion.offer.service.dto

com.broadleafcommerce.promotion.offer.service.dto.comparator - package com.broadleafcommerce.promotion.offer.service.dto.comparator

com.broadleafcommerce.promotion.offer.service.dto.type - package com.broadleafcommerce.promotion.offer.service.dto.type

com.broadleafcommerce.promotion.offer.service.engine - package com.broadleafcommerce.promotion.offer.service.engine

com.broadleafcommerce.promotion.offer.service.engine.application - package com.broadleafcommerce.promotion.offer.service.engine.application

com.broadleafcommerce.promotion.offer.service.engine.application.processor - package com.broadleafcommerce.promotion.offer.service.engine.application.processor

com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper - package com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper

com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item - package com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item

com.broadleafcommerce.promotion.offer.service.engine.candidate - package com.broadleafcommerce.promotion.offer.service.engine.candidate

com.broadleafcommerce.promotion.offer.service.engine.proration - package com.broadleafcommerce.promotion.offer.service.engine.proration

com.broadleafcommerce.promotion.offer.service.messaging.autoconfigure - package com.broadleafcommerce.promotion.offer.service.messaging.autoconfigure

com.broadleafcommerce.promotion.offer.service.messaging.checkout - package com.broadleafcommerce.promotion.offer.service.messaging.checkout

com.broadleafcommerce.promotion.offer.service.validation - package com.broadleafcommerce.promotion.offer.service.validation

com.broadleafcommerce.promotion.offer.web.autoconfigure - package com.broadleafcommerce.promotion.offer.web.autoconfigure

com.broadleafcommerce.promotion.offer.web.context - package com.broadleafcommerce.promotion.offer.web.context

com.broadleafcommerce.promotion.offer.web.context.info - package com.broadleafcommerce.promotion.offer.web.context.info

com.broadleafcommerce.promotion.offer.web.context.validation - package com.broadleafcommerce.promotion.offer.web.context.validation

com.broadleafcommerce.promotion.offer.web.endpoint - package com.broadleafcommerce.promotion.offer.web.endpoint

com.broadleafcommerce.promotion.offer.web.endpoint.exception - package com.broadleafcommerce.promotion.offer.web.endpoint.exception

CombinabilityOverride - Class in com.broadleafcommerce.promotion.offer.domain

Represents a collection of overrides to other combinability and stacking settings.

CombinabilityOverride() - Constructor for class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

CombinabilityOverrideType - Enum in com.broadleafcommerce.promotion.offer.domain.type

Enumerates the combinability override options for an CombinabilityOverride.

combinabilityOverrideValuesToCombinabilityOverrideEntities() - Static method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

CombinabilityType - Enum in com.broadleafcommerce.promotion.offer.domain.type

Enumerates the combinability options for an Offer.

COMBINABLE - com.broadleafcommerce.promotion.offer.domain.type.CombinabilityOverrideType

Specify that the two specific offers can be used in the same order.

CombinedTypesOfferPermutation - Class in com.broadleafcommerce.promotion.offer.service.dto

DTO containing a permutation for each offer type

CombinedTypesOfferPermutation() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

compare(CandidateItemOffer, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.CandidateItemOfferComparator

compare(CandidateItemOffer, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.ItemOfferQtyOneComparator

compare(CandidateItemOffer, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.ItemOfferWeightedPercentSavedComparator

compare(LineItemOfferDetail, LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.QualifierLineItemOfferDetailComparator

Orders by highest amount first.

compare(LineItemOfferDetail, LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

Orders by highest amount first.

compareTo(DiscountTier) - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

Compares priorities.

compareTo(MarketingMessage) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Orders by MarketingMessage.priority.

compareTo(Offer) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Compares priorities.

compareTo(CandidateOrderOffer) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

CompatibleOfferNode - Class in com.broadleafcommerce.promotion.offer.service.dto

This class is used by the OfferProcessingContext to build a tree of compatible offers of the same type.

CompatibleOfferNode() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.CompatibleOfferNode

CompatiblePermutationNode - Class in com.broadleafcommerce.promotion.offer.service.dto

This class is used by the OfferProcessingContext to build a tree of compatible permutations.

CompatiblePermutationNode() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

CompatiblePermutationNode(OfferCombinabilityCriteria, CompatiblePermutationNode) - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

computeAdjustmentValue() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

Calculates the value of the adjustment by first getting the current value of the order and then calculating the value of this adjustment.

computeAdjustmentValue(CandidateFulfillmentGroupOffer, CandidateFulfillmentGroup, OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

Calculates the value of the adjustment .

computeAdjustmentValue(CandidateOrderOffer, OfferProcessingContext, OrderTotals) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

Calculates the value of the adjustment by first getting the current value of the order and then calculating the value of this adjustment.

computeAdjustmentValue(MonetaryAmount, CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

computeAdjustmentValue(MonetaryAmount, CandidateItemOffer) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.PotentialSavingsCalculator

Calls PotentialSavingsCalculator.computeAdjustmentValue(javax.money.MonetaryAmount, com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer, double) with a proration amount of 1 meaning no proration.}

computeAdjustmentValue(MonetaryAmount, CandidateItemOffer, double) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

computeAdjustmentValue(MonetaryAmount, CandidateItemOffer, double) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.PotentialSavingsCalculator

Computes the adjustment value of a CandidateItemOffer for a targeted EnhancedLineItem.

computeDiscountedAmount(CandidateFulfillmentGroup) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

computeOfferPermutationValue(OfferProcessingContext, OffersPermutation<CandidateFulfillmentGroupOffer>, OrderTotals) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

computeOfferPermutationValue(OfferProcessingContext, OffersPermutation<CandidateOrderOffer>, OrderTotals) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

computeOfferPermutationValue(OfferProcessingContext, List<CandidateItemOffer>, OrderTotals) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

computeSaleAdjustmentValue(CandidateItemOffer, LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

computeStandardAdjustmentValue(CandidateItemOffer, LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

convertFromDomain(List<Trackable>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

copy() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

copy(TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

Creates a copy of this adjustment.

copy(TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

Creates a copy of this offer discount.

copy(TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

Creates a copy of this offer discount.

copyDiscountsAndAdjustmentsToNewDetail(TypeFactory, int, LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Copies OfferDiscounts and ItemOfferAdjustments to the given LineItemOfferDetail.

COSTLIEST - com.broadleafcommerce.promotion.offer.domain.type.TargetGroupingStrategy

The default strategy.

couldOfferApplyToGroup(EnhancedFulfillmentGroup, CandidateFulfillmentGroupOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

couldOfferApplyToOrder(EnhancedOrder, CandidateOrderOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

countByOffer(String, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferAuditDetailService

countByOffer(String, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.OfferAuditDetailService

Count all OfferAuditDetail records that relate to the provided offer id.

countByOfferAndCode(String, String, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferAuditDetailService

countByOfferAndCode(String, String, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.OfferAuditDetailService

Count all OfferAuditDetail records that relate to the provided offer id and code.

countByOfferAndUser(String, UserTarget, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferAuditDetailService

countByOfferAndUser(String, UserTarget, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.OfferAuditDetailService

Count all OfferAuditDetail records that relate to the provided offer id and user target.

countByOfferAndUserAndBetweenDates(String, UserTarget, Instant, Instant, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferAuditDetailService

countByOfferAndUserAndBetweenDates(String, UserTarget, Instant, Instant, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.OfferAuditDetailService

Count all OfferAuditDetail records that relate to the provided offer id and user target and that fall between the given dates.

countByOfferId(String, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.OfferAuditDetailRepository

Count all OfferAuditDetail records that relate to the provided offer id.

countByOfferIdAndSharedCode(String, String, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.OfferAuditDetailRepository

Count all OfferAuditDetail records that relate to the provided offer id and shared code id.

countByOfferIdAndUser(String, UserTarget, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferAuditDetailRepository

countByOfferIdAndUser(String, UserTarget, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.CustomizedOfferAuditDetailRepository

Count all OfferAuditDetail records that relate to the provided offer id and user target.

countByOfferIdAndUserAndBetweenDates(String, UserTarget, Instant, Instant, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferAuditDetailRepository

countByOfferIdAndUserAndBetweenDates(String, UserTarget, Instant, Instant, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.CustomizedOfferAuditDetailRepository

Count all OfferAuditDetail records that relate to the provided offer id and user target and that fall between the given dates.

createCandidateFulfillmentGroupOffer(EnhancedOrder, Offer) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.CandidateOfferUtility

Creates a CandidateFulfillmentGroupOffer for the given order and offer.

createCandidateFulfillmentGroupOffer(EnhancedOrder, Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultCandidateOfferUtility

createCandidateFulfillmentItemOffer(EnhancedOrder, Offer) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.CandidateOfferUtility

Creates a CandidateItemOffer for the given order and offer.

createCandidateFulfillmentItemOffer(EnhancedOrder, Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultCandidateOfferUtility

createCandidateOffersFromOffers(Stream<P>, EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

createCandidateOffersFromOffers(Stream<P>, EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Creates a CandidateOffers object by converting the provided offers into their corresponding DTO object based on their DiscountTargetType.

createCandidateOrderItemOffer(EnhancedOrder, Offer) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.CandidateOfferUtility

Creates a CandidateItemOffer for the given order and offer.

createCandidateOrderItemOffer(EnhancedOrder, Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultCandidateOfferUtility

createCandidateOrderOffer(EnhancedOrder, Offer) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.CandidateOfferUtility

Creates a CandidateOrderOffer for the given order and offer.

createCandidateOrderOffer(EnhancedOrder, Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultCandidateOfferUtility

createFulfillmentGroupAdjustment(OfferProcessingContext, CandidateFulfillmentGroupOffer, CandidateFulfillmentGroup, MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

createLineItemRef(EnhancedLineItem) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

createMessage(String, MarketingMessage, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

createNewDetail(TypeFactory, int) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Creates a new LineItemOfferDetail for this item.

createOffer(HttpServletRequest, ContextInfo, Offer) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

createOfferAuditDetail(HttpServletRequest, ContextInfo, OfferAuditDetail) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferAuditDetailsEndpoint

createOfferItemDetail(CandidateItemOffer, String, int) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Creates an OfferItemDetail based on the given fields.

createOfferRef(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

createOrderOfferAdjustment(OfferProcessingContext, CandidateOrderOffer, MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

createPathsForNode(CompatibleOfferNode, Set<BaseCandidateOffer>, Set<CompatibleOfferNode>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

createPlaceholder(CompatiblePermutationNode) - Static method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

createProratedAdjustment(Offer, EnhancedLineItem, LineItemOfferDetail, MonetaryAmount, int) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

createRoot() - Static method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

createUserTarget(String, String) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

createUserTargetForOtherUserType(String, CustomerFields, String) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

customer - Variable in class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

Name of the field passed in as part of UserTarget.targetType that maps to the individual customer.

CUSTOMER - com.broadleafcommerce.promotion.offer.domain.type.UserMaxUsesStrategyType

The Offer.maxUsesPerUser will be determined based on how many times a provided user of UserTarget.targetType "customer" has used the offer

CUSTOMER_EMAIL_PATH - Static variable in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

CUSTOMER_ID_PATH - Static variable in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

customerFields - Variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

CustomerFields - Class in com.broadleafcommerce.promotion.offer.web.context

Configuration properties for defining the names of the customer fields that can be targeted by UserTarget.targetTypes.

CustomerFields() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

CustomizedMarketingMessageRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable> - Interface in com.broadleafcommerce.promotion.offer.repository

Adds customized methods for dealing with MarketingMessage persistence.

CustomizedOfferAuditDetailRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable> - Interface in com.broadleafcommerce.promotion.offer.repository

CustomizedOfferRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable> - Interface in com.broadleafcommerce.promotion.offer.repository

Advanced functionality related to offer maintenance and filtering.

D

DEFAULT - com.broadleafcommerce.promotion.offer.domain.type.CombinabilityType

Represents the default CombinabilityType for a DiscountTargetType.

DefaultCandidateOfferUtility - Class in com.broadleafcommerce.promotion.offer.service.engine.candidate

DefaultCandidateOfferUtility(TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultCandidateOfferUtility

DefaultFulfillmentGroupOfferProcessor - Class in com.broadleafcommerce.promotion.offer.service.engine.application.processor

DefaultFulfillmentGroupOfferProcessor(TypeFactory, RuleEvaluationService, OrderAndItemOfferHelper) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

DefaultItemMarketingMessageResolver<P extends MarketingMessage,O extends Offer> - Class in com.broadleafcommerce.promotion.offer.service

Deprecated.

since 1.6, use MarketingMessageResolver instead

DefaultItemMarketingMessageResolver(MarketingMessageService<P>, MarketingMessageOfferCandidateService<O>) - Constructor for class com.broadleafcommerce.promotion.offer.service.DefaultItemMarketingMessageResolver

Deprecated.

DefaultItemOfferProcessor - Class in com.broadleafcommerce.promotion.offer.service.engine.application.processor

DefaultItemOfferProcessor(PotentialSavingsCalculator, QualifierAndTargetMarker, OrderAndItemOfferHelper, boolean) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

DefaultMarketingMessageOfferCandidateService<P extends Offer> - Class in com.broadleafcommerce.promotion.offer.service

DefaultMarketingMessageOfferCandidateService(OfferCandidateService<P>, RuleEvaluationService) - Constructor for class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageOfferCandidateService

DefaultMarketingMessageResolver<P extends MarketingMessage,O extends Offer> - Class in com.broadleafcommerce.promotion.offer.service

DefaultMarketingMessageResolver(MarketingMessageService<P>, OfferCandidateService<O>, MarketingMessageOfferCandidateService<O>, TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

DefaultMarketingMessageService<P extends MarketingMessage> - Class in com.broadleafcommerce.promotion.offer.service

DefaultMarketingMessageService(MarketingMessageRepository<Trackable>, RsqlCrudEntityHelper) - Constructor for class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageService

DefaultOfferApplicationService - Class in com.broadleafcommerce.promotion.offer.service.engine.application

DefaultOfferApplicationService(ItemOfferProcessor, ItemOfferProcessor, OrderOfferProcessor, FulfillmentGroupOfferProcessor) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

DefaultOfferAuditDetailService<P extends OfferAuditDetail> - Class in com.broadleafcommerce.promotion.offer.service

DefaultOfferAuditDetailService(OfferAuditDetailRepository<Trackable>, RsqlCrudEntityHelper) - Constructor for class com.broadleafcommerce.promotion.offer.service.DefaultOfferAuditDetailService

DefaultOfferCandidateService<P extends Offer> - Class in com.broadleafcommerce.promotion.offer.service.engine.candidate

DefaultOfferCandidateService(OfferService<P>, OfferAuditDetailService<? extends OfferAuditDetail>, RuleEvaluationService, TypeFactory, OfferUserService, CandidateOfferUtility) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

DefaultOfferCodeUsageValidator - Class in com.broadleafcommerce.promotion.offer.service.validation

DefaultOfferCodeUsageValidator(OfferService<? extends Offer>, OfferUserService, TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferCodeUsageValidator

DefaultOfferEngineResponseBuilder<P extends EnhancedProratedItemOfferAdjustment> - Class in com.broadleafcommerce.promotion.offer.service.engine

DefaultOfferEngineResponseBuilder(TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineResponseBuilder

DefaultOfferEngineService - Class in com.broadleafcommerce.promotion.offer.service.engine

DefaultOfferEngineService(OfferCandidateService, OfferApplicationService, OfferEngineResponseBuilder, ProrationService, TypeFactory, OfferProcesingUtility, EntityValidatorManager) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

DefaultOfferService<P extends Offer> - Class in com.broadleafcommerce.promotion.offer.service

DefaultOfferService(OfferRepository<Trackable>, RsqlCrudEntityHelper, CacheStateManager, FilterParser<Node>) - Constructor for class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

DefaultOfferUsageValidator - Class in com.broadleafcommerce.promotion.offer.service.validation

DefaultOfferUsageValidator(OfferAuditDetailService<? extends OfferAuditDetail>, OfferService<? extends Offer>, OfferUserService, TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferUsageValidator

DefaultOfferUserService - Class in com.broadleafcommerce.promotion.offer.service.engine.candidate

DefaultOfferUserService(OfferAuditDetailService<? extends OfferAuditDetail>, CustomerFields, TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

DefaultOrderAndItemOfferHelper - Class in com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper

DefaultOrderAndItemOfferHelper(RuleEvaluationService, TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

DefaultOrderOfferProcessor - Class in com.broadleafcommerce.promotion.offer.service.engine.application.processor

DefaultOrderOfferProcessor(OrderAndItemOfferHelper) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

DefaultPotentialSavingsCalculator - Class in com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item

DefaultPotentialSavingsCalculator(TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

DefaultProrationService - Class in com.broadleafcommerce.promotion.offer.service.engine.proration

DefaultProrationService(TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

DefaultQualifierAndTargetMarker - Class in com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item

DefaultQualifierAndTargetMarker(TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

DefaultVoucherOfferUsageValidator - Class in com.broadleafcommerce.promotion.offer.service.validation

DefaultVoucherOfferUsageValidator(OfferCandidateService<? extends Offer>, OrderAndItemOfferHelper, TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.service.validation.DefaultVoucherOfferUsageValidator

deleteMessage(String, String, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

deleteOffer(HttpServletRequest, ContextInfo, String) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

deleteOfferAuditDetail(HttpServletRequest, ContextInfo, String) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferAuditDetailsEndpoint

determineCodeUsability(String, boolean, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

determineMaxTier(CandidateItemOffer, List<DiscountTier>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

determineOfferDiscountParameters(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

Determines the discount method type and discount amount for the candidate offer, accounting for Offer.getDiscountTiers().

Discount - Class in com.broadleafcommerce.promotion.offer.domain

Encapsulates all of the fields relevant to an offer's discount.

Discount() - Constructor for class com.broadleafcommerce.promotion.offer.domain.Discount

DiscountMethodType - Enum in com.broadleafcommerce.promotion.offer.domain.type

Enumerates the methods whereby to apply an offer's discount to a target.

DiscountParameters - Class in com.broadleafcommerce.promotion.offer.service.dto

Parameters used in the DefaultOfferApplicationService to calculate the potential discount of a CandidateItemOffer for an EnhancedLineItem.

DiscountParameters(String, BigDecimal) - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.DiscountParameters

DiscountTargetType - Enum in com.broadleafcommerce.promotion.offer.domain.type

Enumerates the kinds of entities to which an Discount.getAmount() mount offer's discount} can apply.

DiscountTier - Class in com.broadleafcommerce.promotion.offer.domain

Represents a tier and amount combination for an offer's discount.

DiscountTier() - Constructor for class com.broadleafcommerce.promotion.offer.domain.DiscountTier

DiscountTierListConverter - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Converter used for converting a String List type to a JSON String before persistence.

DiscountTierListConverter(ObjectMapper) - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.DiscountTierListConverter

DiscountTimingType - Enum in com.broadleafcommerce.promotion.offer.domain.type

Enumerates the options for when an offer's discount is be applied.

distributeExclusions() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

In the admin, a user can specify an exclusion from either side of the offer.

doesOfferHaveUsesLeft(Offer, EnhancedOrder, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

E

EITHER - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageTargetType

EnhancedFulfillmentGroup - Class in com.broadleafcommerce.promotion.offer.web.context

EnhancedFulfillmentGroup() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

EnhancedFulfillmentLineItem - Class in com.broadleafcommerce.promotion.offer.web.context

EnhancedFulfillmentLineItem() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentLineItem

EnhancedLineItem - Class in com.broadleafcommerce.promotion.offer.web.context

EnhancedLineItem() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

EnhancedOrder - Class in com.broadleafcommerce.promotion.offer.web.context

EnhancedOrder() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

EnhancedOrderLineItem - Class in com.broadleafcommerce.promotion.offer.web.context

EnhancedOrderLineItem() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

EnhancedProratedItemOfferAdjustment - Class in com.broadleafcommerce.promotion.offer.web.context.info

DTO containing prorated price adjustment information for a EnhancedLineItem caused by a CandidateItemOffer targeting it (see Offer.getTargetItemCriteria()) or using it as a qualifier (see Offer.getItemQualifierCriteria()).

EnhancedProratedItemOfferAdjustment() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

EnhancedProratedOfferAdjustment - Class in com.broadleafcommerce.promotion.offer.web.context.info

EnhancedProratedOfferAdjustment() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.cache.OfferCacheProperties

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.Attribute

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessages

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.SharedCode

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.UserTarget

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaAttribute

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTracking

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTrackingId

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverrideId

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaItemCriteriaRule

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCodeId

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTargetId

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.QualifierLineItemOfferDetailComparator

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.DiscountParameters

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteriaKey

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.Adjustment

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.OfferRef

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentLineItem

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

equals(Object) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

evaluateAgainstRule(String, Serializable) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

Runs the rule against the supplied rootObject via the RuleEvaluationService.

evaluateFulfillmentItemCriteriaAgainstFulfillmentGroups(EnhancedOrder, CandidateFulfillmentGroupOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

evaluateFulfillmentItemCriteriaAgainstOrder(EnhancedOrder, Map<ItemCriteriaRule, Collection<EnhancedFulfillmentLineItem>>, String) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

evaluateGroupForMatchingFulfillmentItems(EnhancedFulfillmentGroup, ItemCriteriaRule) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

evaluateOfferItemCriteriaAgainstOrder(EnhancedOrder, Map<ItemCriteriaRule, Collection<EnhancedLineItem>>, String, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

Evaluates the ItemCriteriaRules from an order or order item targeting offer against the Order to determine whether the offer is applicable.

evaluateOrderForMatchingFulfillmentItems(EnhancedOrder, ItemCriteriaRule) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

evaluateOrderForMatchingItems(EnhancedOrder, ItemCriteriaRule, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

Evaluates the ItemCriteriaRule against the Order's line items to determine if the order matches.

evaluateSubscriptionDiscountAgainstItems(Offer, Map<ItemCriteriaRule, Collection<EnhancedLineItem>>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

EVERYWHERE - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Deprecated.

as of 1.6, use MarketingMessageLocationType.EVERYWHERE() instead

EVERYWHERE() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Returns a list of all location types, indicating it should be shown everywhere.

executeOnOrderAndContext(EnhancedOrder, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

executeOnOrderAndContext(EnhancedOrder, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.OfferEngineService

For the provided order and context, determines the candidate offers and applies them to the order in the permutation that gives the best discount.

expandPermutations(List<CandidateItemOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

This method takes a list of item offers that are compatible with each other and share the same combinability characteristics with other types like order offers and builds additional permutations that influence the order that the offers will be run.

F

filterOffersByItemQualifiers(List<T>, EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

filterOffersByItemQualifiers(List<T>, EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Filter the provided offer set based on if the items of the provided order match as qualifiers.

filterOffersByRequest(Stream<P>, EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

filterOffersByRequest(Stream<P>, EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Filter the provided offer set based on information in the given context of the order.

filterOffersByTotalUses(Stream<P>, EnhancedOrder, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

filterOffersByTotalUses(Stream<P>, EnhancedOrder, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Filter the provided offer set based on the total uses of the offer as well as user uses, while also factoring in Offer.getMaxUsesPerUserFrequency().

filterOffersByUserTarget(Stream<P>, CustomerContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

finalizeAdjustment(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

Sets ItemOfferAdjustment.adjustmentValue and ItemOfferAdjustment.appliedToSalePrice.

finalizeAdjustments(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

finalizeItemPrices() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

finalizeOrderItemPrices() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

finalizePotentialSavingsOnOffer(CandidateItemOffer, TotalPotentialSavings) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

finalizePotentialSavingsOnOffer(CandidateItemOffer, TotalPotentialSavings) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.PotentialSavingsCalculator

Saves the final BaseCandidateOffer.getPotentialSavings() and CandidateItemOffer.getWeightedPercentSaved() for all of an EnhancedOrder.getOrderLineItems() order's order items} if the given CandidateItemOffer was applied.

finalizePrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Sets EnhancedLineItem.getFinalPrice() to the average price of each item, which includes adjustments.

finalizeQuantities() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Updates the target and qualifier quantities to indicate the number that are being used.

finalizeQuantities(List<LineItemOfferDetail>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

finalizeTotal() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Finalize attached adjustments and return adjusted price.

findAllActiveByQualifierAndTargetOffers(Collection<String>, Collection<String>, MarketingMessageRequest, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

findAllActiveByQualifierAndTargetOffers(Collection<String>, Collection<String>, MarketingMessageRequest, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.CustomizedMarketingMessageRepository

Finds all active marketing messages for the given qualifier offer ids, target offer ids, and MarketingMessageRequest.

findAllActiveByQualifierAndTargetOffersAndRequest(Collection<String>, Collection<String>, ItemMarketingMessageRequest, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

findAllActiveByQualifierAndTargetOffersAndRequest(Collection<String>, Collection<String>, ItemMarketingMessageRequest, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.CustomizedMarketingMessageRepository

Deprecated.

since 1.6, use CustomizedMarketingMessageRepository.findAllActiveByQualifierAndTargetOffers(Collection, Collection, MarketingMessageRequest, ContextInfo) instead

findAllByOfferContextId(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.MarketingMessageRepository

findAllByOfferContextIdIn(Collection<String>, Node, Pageable, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

findAllByOfferContextIdIn(Collection<String>, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.CustomizedMarketingMessageRepository

Finds all of the persistent MarketingMessages for the given Offer IDs.

findAllCustomerOffers(Iterable<? extends UserTarget>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferRepository

findAllCustomerOffers(Iterable<? extends UserTarget>, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.CustomizedOfferRepository

Read all offers that have no user targets or contain the provided user targets.

findAllMarketingMessagesForRequest(ItemMarketingMessageRequest, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultItemMarketingMessageResolver

Deprecated.

findAllMarketingMessagesForRequest(ItemMarketingMessageRequest, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.ItemMarketingMessageResolver

Deprecated.

since 1.6

findAllMarketingMessagesForRequest(MarketingMessageRequest, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

findAllMarketingMessagesForRequest(MarketingMessageRequest, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.MarketingMessageResolver

Finds all of the MarketingMessages for the provided MarketingMessageRequest.

findAllMessagesForItemAsQualifierOrTarget(ItemMarketingMessageRequest, Stream<O>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultItemMarketingMessageResolver

Deprecated.

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.

findAllMessagesForItemAsQualifierOrTarget(MarketingMessageRequest, Set<O>, MultiValueMap<String, String>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

Deprecated.

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

findAllMessagesForItemAsQualifierOrTarget(MarketingMessageRequest, Set<O>, MultiValueMap<String, String>, MultiValueMap<String, String>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

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.

findAutomaticAndCodeAndCustomerOffers(Iterable<? extends UserTarget>, Iterable<String>, Iterable<String>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferRepository

findAutomaticAndCodeAndCustomerOffers(Iterable<? extends UserTarget>, Iterable<String>, Iterable<String>, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.CustomizedOfferRepository

Read all offers where Offer#getAutomaticallyConsidered is true, Offer.getCampaignTrackingIds() intersects with the provided tracking ids, Offer.getSharedCodes() intersects with the provided codes, or offers that contain the provided user targets.

findBestFulfillmentGroupOffersForPermutation(OfferProcessingContext, CombinedTypesOfferPermutation) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

findBestFulfillmentGroupOffersForPermutation(OfferProcessingContext, CombinedTypesOfferPermutation) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.FulfillmentGroupOfferProcessor

findBestItemOffersForPermutation(OfferProcessingContext, CombinedTypesOfferPermutation) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

findBestItemOffersForPermutation(OfferProcessingContext, CombinedTypesOfferPermutation) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.ItemOfferProcessor

findBestOrderOffersForPermutation(OfferProcessingContext, CombinedTypesOfferPermutation) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

findBestOrderOffersForPermutation(OfferProcessingContext, CombinedTypesOfferPermutation) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.OrderOfferProcessor

findBestPermutation(EnhancedOrder, List<List<CandidateItemOffer>>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Determines the best permutation by comparing the resulting total discounts of each permutations.

findBySharedCodesCodeIn(Iterable<String>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferRepository

findBySharedCodesCodeIn(Iterable<String>, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.CustomizedOfferRepository

Reads all offers where Offer.sharedCodes intersects with the provided codes.

findFirstCompatibleOffer(BaseCandidateOffer, Set<BaseCandidateOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

findFirstIncompatibleOffer(BaseCandidateOffer, Set<BaseCandidateOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

Based on the compatible flag, return the first compatible or incompatible item from the passed in list

findMaxDiscountTier(CandidateOrderOffer, MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

findRelatedQualifierRootAncestor(EnhancedLineItem) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Repeatedly calls EnhancedOrderLineItem.getParent() until finding the root parent (i.e., an item with no parent) of the item qualifier that needs to be related (e.g., ancestor or descendant) to its targets.

findVoucherOffers(Iterable<? extends UserTarget>, Iterable<String>, Iterable<String>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferRepository

findVoucherOffers(Iterable<? extends UserTarget>, Iterable<String>, Iterable<String>, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.repository.CustomizedOfferRepository

Read all voucher offers where Offer#getAutomaticallyConsidered is true, Offer.getCampaignTrackingIds() intersects with the provided tracking ids, Offer.getSharedCodes() intersects with the provided codes, or offers that contain the provided user targets.

FIXED_PRICE - com.broadleafcommerce.promotion.offer.domain.type.DiscountMethodType

Replace the amount with a fixed price.

fromMe() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

fromMe() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

fromMe() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

FULFILLMENT - com.broadleafcommerce.promotion.offer.service.dto.type.LineItemType

A line item in a EnhancedFulfillmentGroup.

FULFILLMENT_GROUP - com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

Determines that the offer's discount should apply to the cost of fulfilling a group of items with the same fulfillment info (i.e., fulfillment group).

FULFILLMENT_GROUP_ITEM - com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

The offer's discount should apply to the cost of fulfilling individual items.

FULFILLMENT_ITEM_ADJUSTMENTS_PATH - Static variable in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

FULFILLMENT_ITEM_CRITERIA_MAP_COLLECTOR - Static variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

FulfillmentGroupAdjustment - Class in com.broadleafcommerce.promotion.offer.web.context.info

DTO containing price adjustment information for an EnhancedFulfillmentGroup caused by a CandidateFulfillmentGroupOffer targeting it.

FulfillmentGroupAdjustment() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

FulfillmentGroupOfferPermutationResult - Class in com.broadleafcommerce.promotion.offer.service.dto

DTO containing results of the evaluation of a permutation of item offers.

FulfillmentGroupOfferPermutationResult() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

FulfillmentGroupOfferProcessor - Interface in com.broadleafcommerce.promotion.offer.service.engine.application.processor

A service for calculating, determining, and applying the best fulfillment offers.

fulfillmentLineItemOfferProcessor(PotentialSavingsCalculator, QualifierAndTargetMarker, OrderAndItemOfferHelper) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

fulfillmentOfferProcessor(OrderAndItemOfferHelper) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

FUTURE_CREDIT - com.broadleafcommerce.promotion.offer.domain.type.DiscountTimingType

The discount should be credited to the customer at a future time and method, at the discretion of the implementor.

G

get_id() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

get_id() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getAccount() - Method in class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

Name of the field passed in as part of UserTarget.targetType that maps to the account.

getActiveEndDate() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Defines the ending time for which this message is active

getActiveEndDate() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Defines the ending time for which this offer is active.

getActiveEndDate() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getActiveEndDate() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getActiveStartDate() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Defines the beginning time for which this message is active

getActiveStartDate() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Defines the beginning time for which this offer is active.

getActiveStartDate() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getActiveStartDate() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getAdjustedFulfillmentTotalWithoutFutureCredits() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getAdjustedSubtotal() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getAdjustedSubtotalWithoutFutureCredits() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getAdjustedTotal() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The total value of all LineItemOfferDetail.adjustments times the LineItemOfferDetail.quantity of this detail.

getAdjustedTotalUsingSalePrice(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

getAdjustedTotalUsingStandardPrice(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

getAdjustedTotalWithoutFutureCredits() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getAdjustedTotalWithoutFutureCredits() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

Returns the adjusted subtotal of the order by adding the adjusted subtotal with the adjusted fulfillment total.

getAdjustment(Offer, MonetaryAmount, Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineResponseBuilder

Creates an Adjustment caused by the Offer for an order.

getAdjustments() - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

getAdjustments() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderOfferPermutationResult

getAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The ItemOfferAdjustments caused by offers treating the LineItemOfferDetail.lineItem as a target.

getAdjustmentTotal(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Calculates the sum of the fulfillment group adjustments.

getAdjustmentValue() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The final amount by which to adjust the order item's price.

getAllAdjustments(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

getAllCandidateOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

A set of all the relevant candidate offers for given offer engine execution

getAllCustomerOffers(CustomerContext, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

getAllCustomerOffers(CustomerContext, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Retrieve offers that are not customer specific or are customer specific offers for the provided customer.

getAllFulfillmentGroupPermutations() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getAllFulfillmentItemPermutations() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getAllFutureCreditAdjustmentValue(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Gets the sum of all future credit for this fulfillment group (of item and group adjustments).

getAllItemPermutations() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getAllLineItemOfferDetails() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getAllLineItemOfferDetails() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getAllLineItems() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getAllOfferIds() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

Set of ids for all offers that are applicable to a given offer engine execution.

getAllOrderPermutations() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getAllVoucherPermutations() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getAmount() - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

The discount amount that this discount represents.

getAmount() - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

The discount amount that this tier represents.

getAmount() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

getAmount() - Method in class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

getAmount() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

The amount of the adjustment applied to the item.

getAmount() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

The amount of the prorated adjustment for the item.

getAmount() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

getAmount() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

getAppliedOfferIds() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

A list of currently applied offer ids

getAttribute(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

getAttributes() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Dynamic attributes that are a part of the offer.

getAttributes() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getAttributes() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getAttributes() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getAttributes() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getAuditService() - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferUsageValidator

getAutomaticAndCodeAndCustomerOffers(CustomerContext, Codes, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

getAutomaticAndCodeAndCustomerOffers(CustomerContext, Codes, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Retrieve offers that are set to automatically be considered or that correspond to the provided offer code(s) or customer specific offers for the provided customer.

getAveragePrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getBaseDiscountAmount() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

getBaseDiscountMethodType() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

getBaseTotal(CandidateFulfillmentGroup) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

getBeginPeriod() - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

The beginning period for which this offer should be applied.

getBeginPeriod() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getBestFulfillmentGroupOfferPermutation() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getBestFulfillmentItemOfferPermutation() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getBestItemOfferPermutation() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getBestOfferPermutation() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

getBestOrderAdjustmentsForTesting() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

Method facilitates unit testing.

getBestOrderOfferPermutation() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getBestVoucherOfferPermutation() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getBrowseItemMessages() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

Messages that should be displayed on individual product items shown during browse

getBrowseMessages() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

Messages that should be displayed on the product list page headers

getBundleRatio() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The ratio of the offer discount to apply to this item.

getBundleRatioOr1() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

getBusinessDomainType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getBusinessDomainType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getBusinessDomainType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

getCampaignTrackingIds() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The tracking identifiers of the campaigns of which this offer is a part.

getCampaignTrackingIds() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getCandidateFulfillmentGroup() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

getCandidateFulfillmentGroupOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

getCandidateFulfillmentGroupOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

List of candidate offers targeting fulfillment groups.

getCandidateFulfillmentGroups() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

The CandidateFulfillmentGroups that can be targeted by BaseCandidateOffer.offer, each one representing a decorated EnhancedFulfillmentGroup with savings information.

getCandidateFulfillmentItemOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

List of candidate offers targeting fulfillment items.

getCandidateFulfillmentItemOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

getCandidateItemOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The CandidateItemOffer DTO related to ItemOfferAdjustment.offer.

getCandidateItemOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

The CandidateItemOffer DTO related to OfferDiscount.offer.

getCandidateItemOffers(OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

getCandidateOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OffersPermutation

getCandidateOffers(EnhancedOrder, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

getCandidateOffers(ItemMarketingMessageRequest, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageOfferCandidateService

getCandidateOffers(ItemMarketingMessageRequest, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.MarketingMessageOfferCandidateService

Deprecated.

since 1.6

getCandidateOffers(EnhancedOrder, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Get the candidate offers for the provided order and context.

getCandidateOffers(EnhancedOrder, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

getCandidateOffers(EnhancedOrder, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.OfferEngineService

Determines all of the candidate offers that can apply to the provided order for the given context.

getCandidateOrderItemOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

List of candidate offers targeting order items.

getCandidateOrderItemOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

getCandidateOrderOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

getCandidateOrderOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

List of candidate offers targeting orders.

getCandidateQualifiersMap() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedFulfillmentLineItem that meet that criteria for this CandidateFulfillmentGroup.fulfillmentGroup.

getCandidateQualifiersMap() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedLineItem that meet that criteria.

getCandidateQualifiersMap() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedLineItem that meet that criteria.

getCandidateTargetsMap() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Map of ItemCriteriaRule from an offer's target item criteria to a Collection of EnhancedLineItem that meet that criteria.

getCandidateVoucherOffers(EnhancedOrder, boolean, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

getCandidateVoucherOffers(EnhancedOrder, boolean, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Get the candidate voucher offers for the provided order and context.

getCartItemMessages() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

Messages that should be displayed on individual cart items

getCartLabel() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

A label for this offer typically used by the storefront.

getCartLabel() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getCartMessages() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

Messages that should be displayed on the cart page's header

getCartProductIds() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The ids of any products currently in the customer's cart

getCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The subtotal of the customer's cart

getCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The minimum cart subtotal to apply this offer.

getCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getCategoryId() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The current category's id

getChildNodes() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

getChildren() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

Not part of the incoming or outgoing payloads but populated at the start of the offer engine in order to provide faster lookup during processing.

getCode() - Method in class com.broadleafcommerce.promotion.offer.domain.SharedCode

The code string associated to this shared code and used to apply the associated offer to an order.

getCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

getCodes() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

DTO containing codes used to apply offers to orders.

getCodes() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getCodeUsabilityInfo(String, List<? extends Offer>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

getCodeUsabilityInfo(String, List<? extends Offer>, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferUserService

Checks the provided SharedCode.getCode() SharedCode's code} against the provided Offers' SharedCodes to determine whether the code is usable.

getCodeUsed() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.Adjustment

getCodeUses(Offer, SharedCode, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

getCombinabilityCriteria() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

getCombinabilityOverrides() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The CombinabilityOverrides that override how this offer combines with other offers.

getCombinabilityOverrides() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getCombinabilityType() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether this offer can be combined with other offers.

getCombinabilityType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getCombinableOverrides() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

Convert offer data into easier structures for combinability algorithms

getCombinedTypesOfferPermutations() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

getCompatibleOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

getConnectiveOperator() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

The connective with which to join all of the ItemCriteria.rules together.

getContextId() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getContextId() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getContextId() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

getContextInfo() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The ContextInfo derived from the original request containing tenant and sandbox info.

getContextState() - Method in class com.broadleafcommerce.promotion.offer.domain.Attribute

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.promotion.offer.domain.SharedCode

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.promotion.offer.domain.UserTarget

A subset of Tracking information to expose the context state for this object.

getCountMaxUserUses(Offer, ContextInfo, UserTarget) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

getCriteriaSetsByType() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

Builds a list consisting of the sets of OfferCombinabilityCriteria for each offer type.

getCurrency() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

Transient property that holds the currency used to convert price to a MonetaryAmount.

getCurrency() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

Transient property that holds the currency used to convert price to a MonetaryAmount.

getCurrency() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

The EnhancedOrder.getCurrency() order's currency code}.

getCurrency() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getCurrency() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getCustomer() - Method in class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

Name of the field passed in as part of UserTarget.targetType that maps to the individual customer.

getCustomerContext() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

getCustomerContext() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The customer context information that should be used in determiningwhich offers apply

getCustomerContext() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getCustomLineItemType(EnhancedLineItem) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

getDatasource() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

getDateApplied() - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The date and time when the related offer was applied.

getDateApplied() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

getDelegating() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

getDescription() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Description of this offer.

getDescription() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getDestination() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getDiscount() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Basic discount information for this offer.

getDiscountableItemsTotal(MonetaryAmount, List<? extends EnhancedLineItem>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

Gets the discountable total for the given EnhancedLineItems.

getDiscountablePriceForOrder() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

getDiscountAmount() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getDiscountAmount() - Method in class com.broadleafcommerce.promotion.offer.service.dto.DiscountParameters

getDiscountedAmount() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

The amount off this fulfillment group would get if the candidate offer was applied.

getDiscountedAmount(CandidateFulfillmentGroup) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

getDiscountedTotal() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

The adjusted discounted price for this candidate fulfillment group if the candidate offer was applied.

getDiscountMethodType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getDiscountMethodType() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

Convenience method to access this property to improve code readability

getDiscountMethodType() - Method in class com.broadleafcommerce.promotion.offer.service.dto.DiscountParameters

getDiscountProrationType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getDiscountTargetType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getDiscountTargetType() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

Convenience method to access this property to improve code readability

getDiscountTiers() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

List of discount tiers determining the discount applied with this offer.

getDiscountTiers() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getDiscountTimingType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getDisplay() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getDisplay() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getDisplay() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

getDisplayHint() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Defines a hint to the client on how to display this message

getDisplayHint() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getDocumentContext(String) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

Parses the message payload into a `DocumentContext` which allows for JsonPath parsing using Jackson providers.

getEndPeriod() - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

The ending period for which this offer should be applied.

getEndPeriod() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getEstimatedFreeGiftValue(EnhancedOrder, Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

getEstimatedValue() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Provide an estimated value for this offer.

getEstimatedValue() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

Estimated value for this offer, used in scoring the best offer permutation for voucher and free gift offers.

getEstimatedVoucherValue(EnhancedOrder, Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

getFaxNumber() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getFGid(FulfillmentGroupAdjustment) - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

getFinalAdjustmentValue(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

getFinalAdjustmentValueIncludingFutureDiscounts(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

getFinalItemAdjustmentsValue(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getFinalizedQuantity() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

The actual item quantity of an EnhancedLineItem matched to the OfferDiscount.offer.

getFinalizedQuantity() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

The actual item quantity of an EnhancedLineItem matched to the OfferQualifier.offer.

getFinalizedTotalWithAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Returns the final total for this item taking into account the finalized orderAdjustments.

getFinalPrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

The final price, including adjustments, for a single merchandising item represented by this order line item.

getFinalTotalAdjustmentValue() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getFinalTotalAdjustmentValue(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

getFreeGiftItems() - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

getFreeGiftItems() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getFreeGiftQuantityToAdd(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Gets the quantity of the free gift items to be added from the given CandidateItemOffer.

getFreeProduct() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Defines the id of the free product for this offer.

getFreeProduct() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getFriendlyDiscountAmount() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

getFriendlyName() - Method in enum com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

getFriendlyOfferType() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

getFulfillmentAdjustmentAmount(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Calculates the total adjustment for this group and its items.

getFulfillmentGroup() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

The EnhancedFulfillmentGroup that is decorated for consideration as part of a CandidateFulfillmentGroupOffer.

getFulfillmentGroupCriteria() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

String expression used to determine if a fulfillment group qualifies for this offer.

getFulfillmentGroupCriteria() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getFulfillmentGroupCriteriaMap() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

getFulfillmentGroupFutureCredits() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getFulfillmentGroupResponse(EnhancedOrder, EnhancedFulfillmentGroup, Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineResponseBuilder

Creates an offer fulfillment group response for a fulfillment group.

getFulfillmentGroups() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getFulfillmentItemCriteriaMap() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

getFulfillmentItemMatchResults(String, EnhancedFulfillmentGroup) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

getFulfillmentItems() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getFulfillmentLineItems() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getFulfillmentOptionName() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getFulfillmentOptionType() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getFullPathName() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

getFutureCreditAdjustmentValue() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getFutureCredits() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getFutureCreditValue(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

getGetTotalSavings() - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

getGroupAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getHelper() - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

getHelper() - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultVoucherOfferUsageValidator

getId() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

getId() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The context ID of the offer.

getId() - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The context ID of the offer audit detail

getId() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.OfferRef

getId() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getId() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getIdempotentConsumptionService() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

getItem() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

getItemAdjustment(ItemOfferAdjustment, Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineResponseBuilder

Creates an ItemAdjustment for the ItemOfferAdjustment.

getItemCriteriaCollectionMap(ItemCriteria, EnhancedFulfillmentGroup) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

getItemFutureCredits(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getItemOfferCriteriaMap() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

getItemQualifierCriteria() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Info related to determining what items are required so that an order or other items qualify to receive this offer's discount.

getItemQualifierCriteria() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

The Offer.getItemQualifierCriteria() that an EnhancedLineItem matched.

getItemResponse(EnhancedLineItem, Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineResponseBuilder

Creates an Offer ItemResponse for a line item.

getItemResponseDetail(CurrencyUnit, LineItemOfferDetail, Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineResponseBuilder

Creates an Offer ItemResponseDetail for a LineItemOfferDetail.

getItemRestrictionType(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Translates the combination of Offer.qualifiersCanBeTargets and Offer.qualifiersCanBeQualifiers into an enum value.

getItemsAdjustmentsValue(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Gets the sum of the fulfillment items total adjustments.

getJpa() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

getKey() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

getLineItem() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

The LineItemRef of the EnhancedLineItem that gets this adjustment.

getLineItem() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

The LineItemRef of the EnhancedLineItem that gets this adjustment.

getLineItem() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

getLineItem() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The EnhancedLineItem affected by offers.

getLineItemDetailMap() - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

getLineItemOfferDetail() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

getLineItemOfferDetails(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getLineItems() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

A list of hydrated EnhancedLineItems used by the MarketingMessageResolver to retrieve MarketingMessages

getLineItems(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getLineItemType(EnhancedLineItem) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

getLineNumber() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getLiquibase() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

getLocale() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

getLocale() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Deprecated.

since 1.6 use translations for different locales

getLocale() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

Deprecated.

getLocale() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getLocationType() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

getLocationType() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Deprecated.

since 1.6 functionality moved to MarketingMessage.locationTypes.

getLocationType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

Deprecated.

getLocationTypes() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Determines in what locations this message can appear, whether on product detail, browse, search, or cart pages or everywhere.

getLocationTypes() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getMarketingMessageService() - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

getMarketingMessagesForItem(ItemMarketingMessageRequest, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.ItemMarketingMessageRetrievalEndpoint

Deprecated.

getMarketingMessagesForRequest(MarketingMessageRequest, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessageRetrievalEndpoint

getMaxCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

The maximum cart subtotal to display this message.

getMaxCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getMaxMessageCount() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The maximum number of messages for each location and location / product combination

getMaxSavingsPerOrder() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the maximum savings a single order can receive from this offer.

getMaxSavingsPerOrder() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getMaxTierForTieredItemQty(CandidateItemOffer, List<DiscountTier>, int) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

getMaxTierForTieredItemSubtotal(CandidateItemOffer, List<DiscountTier>, BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

getMaxUses() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the maximum number of times this offer can be used.

getMaxUses() - Method in class com.broadleafcommerce.promotion.offer.domain.SharedCode

Defines the maximum number of times that this code can be used regardless of Order or Customer.

getMaxUses() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getMaxUses() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

getMaxUsesPerOrder() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the maximum number of times this offer can be used on a single order.

getMaxUsesPerOrder() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getMaxUsesPerUser() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the maximum number of times this offer can be used by the same user.

getMaxUsesPerUser() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getMaxUsesPerUserFrequency() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

This field works in conjunction with Offer.maxUsesPerUser to limit the frequency with which an individual user can use this offer.

getMaxUsesPerUserFrequency() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getMaxUsesPerUserStrategy() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Enum that allows implementations to vary how user max uses will be interpreted.

getMaxUsesPerUserStrategy() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getMerchandiseTotal() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Return the total price of all order line items in the fulfillment group.

getMessages() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessages

getMethodType() - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Determines the method used to apply the discount.

getMethodType() - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

Determines the method used to apply the discount.

getMethodType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

getMinAmount() - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

The minimum currency amount to qualify for this tier.

getMinAmount() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

getMinCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

The minimum cart subtotal to display this message.

getMinCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getMinQuantity() - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

The minimum quantity of items needed to reach this tier.

getMinQuantity() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

getMinTotalOfQualifierPrices() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the price subtotal threshold that all qualifying items must reach in addition to Offer.itemQualifierCriteria in order to qualify an order items to receive this offer's discount.

getMinTotalOfQualifierPrices() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getMinTotalOfTargetPrices() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the price subtotal threshold that all targeted items must reach in addition to Offer.targetItemCriteria in order to receive this offer's discount.

getMinTotalOfTargetPrices() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getMoneyRoundingHelper() - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

getName() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Display name for this offer.

getName() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getName() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

getNonCombinableOverrides() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

getNumberOfMatchesRequired() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

getNumberOfMatchesRequired() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaItemCriteriaRule

getObjectMapper() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

getOffer() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTracking

getOffer() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

getOffer() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

getOffer() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

getOffer() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

The candidate Offer.

getOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

The OfferRef for the Offer that caused this adjustment to be applied.

getOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

The OfferRef for the offer where this prorated adjustment is from.

getOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

getOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

getOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

getOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

The Offer using some EnhancedLineItem as an item qualifier.

getOffer() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

getOfferAuditDetailService() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

getOfferByAutomatic() - Method in class com.broadleafcommerce.promotion.offer.cache.OfferCacheProperties

getOfferByUserTargets() - Method in class com.broadleafcommerce.promotion.offer.cache.OfferCacheProperties

getOfferCandidateService() - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultVoucherOfferUsageValidator

getOfferCombinabilityCriteriaKey() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

Holds the combinability criteria for this offer.

getOfferContextId() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getOfferDetails() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

DTOs containing information about offers applicable to this item.

getOfferDiscounts() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Additional info for all the offers treating the LineItemOfferDetail.lineItem as a target.

getOfferDiscountStrategy() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Returns the discount strategy.

getOfferDiscountStrategy() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getOfferFactory() - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

getOfferFactory() - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

getOfferFactory() - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.OrderAndItemOfferHelper

getOfferFactory() - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineResponseBuilder

getOfferFactory() - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferCodeUsageValidator

getOfferFactory() - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferUsageValidator

getOfferFactory() - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultVoucherOfferUsageValidator

getOfferId() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Id of the parent Offer.

getOfferId() - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The associated offer's id.

getOfferId() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

getOfferId() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

Convenience method to access this property to improve code readability

getOfferMessagingProperties() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

getOfferPriority() - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

getOfferQualifiers() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Additional information about the offers using the LineItemOfferDetail.lineItem as item qualifiers.

getOfferRef() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.Adjustment

getOfferRef(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineResponseBuilder

Creates an OfferRef for the given Offer.

getOfferService() - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferCodeUsageValidator

getOfferService() - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferUsageValidator

getOfferService() - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

getOffersToFilter(EnhancedOrder, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

getOffersToFilter(EnhancedOrder, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Get available offers that need to be filtered to become candidates.

getOfferTargetType() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OffersPermutation

getOfferTypeOnlyTarget() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

getOfferTypOnlyMethod() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

getOfferUserService() - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferCodeUsageValidator

getOfferUserService() - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferUsageValidator

getOfferUses() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The number of times that the offer this adjustment was created from is applied.

getOrder() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

The order being targeted by BaseCandidateOffer.getOffer() }.

getOrder() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

getOrder() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

getOrderAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getOrderCriteria() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

String expression used in conjunction with Offer.itemQualifierCriteria to determine if an order qualifies for this offer.

getOrderCriteria() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getOrderId() - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The id of the order upon which the related offer was used.

getOrderId() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

getOrderLineItem() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentLineItem

The corresponding EnhancedOrderLineItem for this EnhancedFulfillmentLineItem.

getOrderLineItems() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getOrderNumber() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getOrderOfferCriteriaMap() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

getOrderSubmitDate() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getOrderTotals() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

getOriginalPrice() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

The original, unadjusted price of the item being targeted by BaseCandidateOffer.getOffer().

getOtherTypeOfferIdExclusions() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteriaKey

getOtherTypeOfferIdsList() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

For combinability algorithms, it is helpful to know the ids of all other offer types.

getOverrideType() - Method in class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

The type of override being performed for this offer combination.

getOverrideType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

getParent() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

Not part of the incoming or outgoing payloads but populated at the start of the offer engine in order to provide faster lookup during processing.

getParentDetail() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

getParentDetail() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

getParentLineNumber() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

getParentNode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

getPathExcludedIds() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

The set of excluded ids from each CriteriaKey in the path.

getPathOfferIds() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

The set of offer ids being applied in this path so far.

getPermutationByComparator(List<CandidateItemOffer>, Comparator<CandidateItemOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Uses a Comparator to sort candidate offers.

getPermutations() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

getPermutationTotals() - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

getPermutationTotals() - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

getPermutationTotals() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderOfferPermutationResult

getPotentialSavings() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

The total potential amount saved by applying this offer to its targets.

getPotentialSavingsQtyOne() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Potential savings per single use of BaseCandidateOffer.getOffer().

getPreviousItemCriteria(LineItemOfferDetail, Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

getPrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

Tracks the discount amount of the related item qualifier.

getPrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Convenience method to get either the EnhancedLineItem.getSalePrice() or EnhancedLineItem.getStandardPrice() depending on the flag.

getPriceBeforeAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getPrimaryPhone() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getPriority() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

When multiple messages match a context, the message with the higher priority wins out, where smaller integer values represent higher priorities.

getPriority() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

When multiple offers match a context, the offer with the higher priority is applied first, where smaller integer values represent higher priorities.

getPriority() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getPriority() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getPriority() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

The priority of the BaseCandidateOffer.offer.

getPriorityForComparisons() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

getProductDetailMessages() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

Messages that should be displayed on product detail pages

getProductIds() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The ids for all products to retrieve marketing messages for

getProratedAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Prorated offer adjustment information for this line item.

getProratedAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The ProratedItemOfferAdjustments caused by offers with Discount.getProrationType() or ProrationType.TARGET_AND_QUALIFIER treating both LineItemOfferDetail.lineItem as a target and the items that qualify it.

getProratedFulfillmentAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Prorated fulfillment adjustments for the fulfillment group itself.

getProrationType() - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Determines how an offer's discount amount is distributed across the offer's related order item types.

getQtyAvailableToBeUsed(CandidateItemOffer, boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Calculates the number of order items not already exclusively used as targets or qualifiers either by this offer or any other and, therefore, are available to be used as qualifiers or targets by the given Offer.

getQtyAvailableToUseAsQualifier(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Calculates the number of order items available to be used as qualifiers for the provided Offer.

getQtyAvailableToUseAsTarget(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Calculates the number of order items available to be used as targets for the provided Offer.

getQualifierDetails() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

A list of OfferItemDetails representing the qualifier items where this adjustment was from.

getQualifierDetails(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Gets a list of OfferItemDetails representing qualifiers.

getQualifierItemCriteriaConnectiveOperator() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getQualifierItemCriteriaRules() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getQuantity() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getQuantity() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

The quantity of merchandising items from the EnhancedLineItem to which this adjustment applies.

getQuantity() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

getQuantity() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The quantity of items related to this detail.

getQuantity() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

The potential item quantity of an EnhancedLineItem that matched the OfferDiscount.offer.

getQuantity() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

The potential item quantity of an EnhancedLineItem that matched the OfferQualifier.offer.

getQuantityOfItemsExclusivelyUsedAsQualifiers(CandidateItemOffer, Set<OfferQualifier>, boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Calculates the number of order items already exclusively used as qualifiers.

getQuantityOfItemsExclusivelyUsedAsTargets(CandidateItemOffer, Set<OfferDiscount>, boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Calculates the number of order items already exclusively used as targets.

getQuantityPerUsage() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The quantity per offer usage of the item where this adjustment is applied to (target item).

getRelatedOfferRef() - Method in class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

The id of an offer for which combinability is being overridden for this offer.

getRelatedOfferRef() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

getRelatedOrderLineItemNumber() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentLineItem

getRepository() - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageService

getRepository() - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferAuditDetailService

getRepository() - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

getRepositoryDomain() - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageService

getRepositoryDomain() - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

getRepositoryDomain() - Method in interface com.broadleafcommerce.promotion.offer.service.MarketingMessageService

getRepositoryDomain() - Method in interface com.broadleafcommerce.promotion.offer.service.OfferService

getRoundingMode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

The RoundingMode to use when rounding.

getRoundingMode() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

getRule() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

String expression used to determine which items must be present so that an order may receive this offer's discount.

getRule() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaItemCriteriaRule

getRuleEvaluationService() - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

getRuleEvaluationService() - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.OrderAndItemOfferHelper

getRules() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

Rules that comprise this criteria.

getSaleAdjustmentValue() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The amount by which to adjust the EnhancedLineItem.getSalePrice().

getSalePrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getSecondaryPhone() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

getSegment() - Method in class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

Name of the field passed in as part of UserTarget.targetType that maps to the customer segment.

getService() - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

getSharedCode() - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The string of the shared code used to apply the related offer if one was used.

getSharedCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

getSharedCodes() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The SharedCodes that can be used to retrieve this offer.

getSharedCodes() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getShowIfOfferApplied() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getSortedItemOfferDetails(Offer, Collection<? extends EnhancedLineItem>, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

getStackableOverrides() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

getStandardAdjustmentValue() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The amount by which to adjust the EnhancedLineItem.getStandardPrice().

getStandardPrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getSubscriptionDiscount() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Information around discounting subscription items that have recurring billing.

getSubtotal() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getSubtotalAsDouble() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getSubTotalWithAdjustments() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

getTargetGroupingStrategy() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The target grouping strategy.

getTargetGroupingStrategy() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getTargetGroupingStrategy() - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

The target grouping strategy.

getTargetItemCriteria() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Info related to determining what order items can receive this offer's discount.

getTargetItemCriteria() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

The Offer.getTargetItemCriteria() that an EnhancedLineItem matched.

getTargetItemCriteriaConnectiveOperator() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getTargetItemCriteriaRules() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getTargetType() - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Determines the type of entity that receives the discount.

getTargetType() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Determines whether this message should appear only next to its offer's targets or qualifiers or next to both.

getTargetType() - Method in class com.broadleafcommerce.promotion.offer.domain.UserTarget

The type of the user.

getTargetType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getTargetType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

getTargetType() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

getTargetType() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteriaKey

getTargetValue() - Method in class com.broadleafcommerce.promotion.offer.domain.UserTarget

An identifying value for the user.

getTargetValue() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

getTargetValue() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

getTemplate() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

getText() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

The actual text of the message to display.

getText() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getTieredDiscount() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

Deprecated.

getTimeCriteria() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

String expression used to determine whether this offer can be qualified for only at certain times or on certain days or months.

getTimeCriteria() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getTimeOfRequest() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getTimingType() - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Determines the timing of the discount's application.

getTotal() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Gets the total for this fulfillment group.

getTotalAdjustments() - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

getTotalAdjustments() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderOfferPermutationResult

getTotalAdjustments() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

getTotalAdjustmentsValue() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getTotalAdjustmentValue() - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

getTotalBeforeAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Gets the total before adjustments for this fulfillment group.

getTotalFreeGiftsValue() - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

getTotalFufillmentCharges() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getTotalFulfillmentAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getTotalFulfillmentGroupAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getTotalFutureCredits() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getTotalPrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Gets the total combined price of this order item, including any adjustments.

getTotalPrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

Gets the total combined price of this order item, including any adjustments.

getTotalPriceWithoutAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getTotalSavings() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

Total savings across all CandidateFulfillmentGroupOffer.candidateFulfillmentGroups for the BaseCandidateOffer.offer.

getTotalStandardPrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getTotalTimesCriteriaIsMetByCriteria(Map<ItemCriteriaRule, Collection<EnhancedLineItem>>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

getTotalTimesCriteriaIsMetByCriteria(Map<ItemCriteriaRule, Collection<EnhancedLineItem>>) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.OrderAndItemOfferHelper

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

getTotalValue() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

getTotalVouchersValue() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderOfferPermutationResult

getTotalWithAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Calculates the total for this fulfillment group with adjustments.

getTotalWithoutFutureCredits(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Gets the total for this fulfillment group excluding future credits.

getTracking() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getTracking() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getTracking() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

getTrackingId() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTracking

getTranslationEntityService() - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

getTranslationEntityService() - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

getTreeLevel() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

getTypeFactory() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

getUnadjustedSalePrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

getUnitAmount(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.MoneyRoundingHelper

Determines the smallest unit amount of money for the CurrencyUnit.

getUseCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

getUser() - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The identifying info of the user that used the related offer.

getUserIdForOtherUserType(CustomerContext, String) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

getUserTargets() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Set of users directly targeted by this offer.

getUserTargets() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getUserTargetValue(DocumentContext) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

Retrieves the value to set for the UserTarget.getTargetValue() on the audit detail(s).

getUses() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Tracks the number of times this candidate offer has been used.

getValidator() - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

getValue() - Method in class com.broadleafcommerce.promotion.offer.domain.Attribute

The value represented by this attribute.

getValue() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaAttribute

getVoucherCampaign() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Defines the id of the campaign for this offer.

getVoucherCampaign() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

getVoucherCriteriaMap() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

getVoucherOffers(CustomerContext, Codes, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

getVoucherOffers(CustomerContext, Codes, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Retrieve voucher offers that are set to automatically be considered or that correspond to the provided offer code(s) or customer specific offers for the provided customer.

getVouchers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderOfferPermutationResult

getVouchers() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

getWeightedPercentSaved() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Takes the BaseCandidateOffer.getPotentialSavings() and divides them by the item's price before multiply by 100 to get a percentage.

getWeightedSavingsPercentage() - Method in class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

H

handleBadOrderException(Exception, WebRequest) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

hasAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

hasDetails() - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

hashCode() - Method in class com.broadleafcommerce.promotion.offer.cache.OfferCacheProperties

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.Attribute

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessages

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.SharedCode

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

hashCode() - Method in class com.broadleafcommerce.promotion.offer.domain.UserTarget

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaAttribute

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTracking

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTrackingId

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverrideId

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaItemCriteriaRule

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCodeId

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTargetId

hashCode() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.QualifierLineItemOfferDetailComparator

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.DiscountParameters

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteriaKey

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.Adjustment

hashCode() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.OfferRef

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentLineItem

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

hashCode() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

hasItemQualifierCriteriaRules() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Whether this offer has item qualifier rules to be matched.

hasLimitedUsesPerOrder() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Whether this Offer has limited uses per order.

hasOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

hasOrderItemAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

hasTargetItemCriteriaRules() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Whether this offer has target item rules to be matched.

helper - Variable in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

helper - Variable in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

I

incrementQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

Increments the OfferDiscount.quantity by the given amount.

incrementQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

Increments the OfferQualifier.quantity by the given amount.

incrementTotalSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

incrementTotalSavingsPerCandidate(EnhancedOrder, CandidateFulfillmentGroupOffer, List<CandidateFulfillmentGroup>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

incrementUses() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

initializeCandidateOfferForProcessing(BaseCandidateOffer) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

Adds the offer to the relevant collections used by the offer engine.

initializeCurrency(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

Orders should already have a currency but if one is not present on the order, this method will populate it with the system default.

initializeFulfillmentItemOfferDetails(TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

initializeOrder(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

initializeOrderItemOfferDetails(TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

initializeOrderTotals(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.OfferProcesingUtility

initializePermutations() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

Build unique permutations by offer type where a permutation is grouped by how the permutation can combine with other offer types

initializePermutations(List<? extends BaseCandidateOffer>, Map<OfferCombinabilityCriteriaKey, OfferCombinabilityCriteria>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

initializePriceDetails(TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Ensures that an LineItemOfferDetail is present so that the offer engine engages correctly.

INSTANCE - Static variable in class com.broadleafcommerce.promotion.offer.service.dto.comparator.CandidateItemOfferComparator

INSTANCE - Static variable in class com.broadleafcommerce.promotion.offer.service.dto.comparator.ItemOfferQtyOneComparator

INSTANCE - Static variable in class com.broadleafcommerce.promotion.offer.service.dto.comparator.ItemOfferWeightedPercentSavedComparator

IS_FREE_GIFT_ITEM - Static variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

isAdjustmentGoodEnough(CandidateItemOffer, LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Checking to make sure that an offer's adjustment to an item's price is actually better than the original price, especially if the item is on sale since not all offers can apply to a sale price.

isAdjustmentsFinalized() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Whether the LineItemOfferDetail.adjustments are the orderAdjustments to actually use rather than being potential or incomplete.

isAmountOff(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountMethodType

isAnyCodeUsable(Set<String>, Offer, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

isAnyCodeUsable(Set<String>, Offer, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferUserService

For the provided codes, check if there is no more usage for the provided offer available.

isAnyCombinabilityType(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.CombinabilityType

isAnyMatchCriteria(String) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

Checks whether the operator matches DefaultConnectiveOperatorType.OR, meaning that only 1 of the ItemCriteria's rules need be matched.

isAnyMatchFoundAcrossAllItems(EnhancedOrder, CandidateFulfillmentGroupOffer, Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

isAnyMatchFoundInAnyFulfillmentGroup(EnhancedOrder, CandidateFulfillmentGroupOffer, Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

isAParentOf(EnhancedOrderLineItem) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

Determines whether this item is a direct parent or general ancestor of the given item.

isApplicableToDependentItems() - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Whether this discount should apply to an item's dependent order items (e.g., add-ons).

isApplicableToSalesPrice() - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Whether this discount should apply to an item's sale price or just its non-sale price(s).

isAppliedToSalePrice() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

Whether the ItemOfferAdjustment.adjustmentValue was applied to EnhancedLineItem.getStandardPrice() or EnhancedLineItem.getSalePrice().

isApplyToFuturePeriods() - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

Whether an offer should be applied to items' future periods, i.e., items that have a recurring billing cycle based on a frequency and a period.

isApplyToFuturePeriods() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isAutomaticallyConsidered() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether this offer should be considered to be applied without needing any Offer.sharedCodes or Offer.campaignTrackingIds (or some other, similar constraint).

isAutomaticallyConsidered() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isCombinable() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Returns true if the combinabilityType is CombinabilityType.ANY OR if the combinabilityType is and the discount target type for the offer is {@link DiscountTargetType#ORDER_ITEM} ITEM. Otherwise, returns false.

isCombinable() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

isCombinable() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

isCombinable() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

isCombinableWithOtherTypes() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

isCompatibleWithOtherType(CompatiblePermutationNode) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

isCompatibleWithOtherTypes() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteriaKey

isCriteriaMatched(EnhancedLineItem, ItemCriteria) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageOfferCandidateService

isCriteriaMatched(EnhancedLineItem, ItemCriteria) - Method in interface com.broadleafcommerce.promotion.offer.service.MarketingMessageOfferCandidateService

Determines whether the EnhancedLineItem matches the ItemCriteria.

isDefaultCombinabilityType(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.CombinabilityType

isDependent() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Whether this item is an Add-on/dependant type, that is, an item that cannot be sold or fulfilled on its own but as a child of another item.

isDiscountable() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

isDiscountApplicableToDependentItems() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isDiscountApplicableToSalesPrice() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isDiscountCurrentOrder() - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

Whether to apply this discount to the current provided order.

isDiscountCurrentOrder() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isDiscountCurrentOrder() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

isDistributeOfferAmountToTargets() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

This property impacts the way that items share the same discount.

isDistributeOfferAmountToTargets() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isEmpty() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

isFixedPrice(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountMethodType

isFreeGift() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether this is a free gift offer.

isFreeGift() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isFreeGiftItem(EnhancedLineItem) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

Determines if the given EnhancedLineItem is a free gift item.

isFulfillmentGroupItemOffer(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

isFulfillmentGroupOffer(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

isFulfillmentItemTargetType(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

isFulfillmentTargetType(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

isFutureCredit() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Future credit means that the associated adjustment will be discounted at a later time to the user via a credit.

isFutureCredit() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

isFutureCredit() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

Future credit means that the associated adjustment will be discounted at a later time to the customer via a credit.

isFutureCredit() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

isHasOffers() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

isItemOffer(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultItemMarketingMessageResolver

Deprecated.

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

isItemOffer(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

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

isItemQualifier(Offer, ItemMarketingMessageRequest) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultItemMarketingMessageResolver

Deprecated.

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.

isItemQualifier(Offer, EnhancedLineItem) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

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.

isItemRelatedToQualifier(EnhancedLineItem, LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

isItemTarget(Offer, ItemMarketingMessageRequest) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultItemMarketingMessageResolver

Deprecated.

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.

isItemTarget(Offer, EnhancedLineItem) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

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.

isLeafElement() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatibleOfferNode

isLeafElement() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

isLessThanOrEqualTo(BigDecimal, BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

isLessValueThan(FulfillmentGroupOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

isLessValueThan(ItemOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

isLessValueThan(OrderOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderOfferPermutationResult

isMatchingQualifier(Offer, OfferQualifier) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

isMinSubtotalMet(MonetaryAmount, Set<? extends EnhancedLineItem>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

isNonCombinableGroupOfferApplied() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

isNonCombinableOfferApplied() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

isNonCombinableOrderOfferApplied() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

isNoneCombinabilityType(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.CombinabilityType

isOnSale() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

isOrderItemOffer(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

isOrderItemTargetType(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

isOrderOffer(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

isOrderTargetType(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

isOtherTypeCombinabilityType(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.CombinabilityType

isPercentOff(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountMethodType

isPercentOffOffer(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

isPlaceHolderNode() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

isPreferCartBundling() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

This property provides a hint to the front-end application to perform grouping for items that share the same discount.

isPreferCartBundling() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isProrationRequiredForAdjustment(ItemOfferAdjustment) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

isQualifiersCanBeQualifiers() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether items that qualify an order to receive this offer's discount can also be used as qualifiers for other offers of the same type (e.g., Order, Order Item, Fulfillment).

isQualifiersCanBeQualifiers() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isQualifiersCanBeTargets() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether items that qualify an order to receive this offer's discount can also receive discounts from other offers of the same type (e.g., Order, Order Item, Fulfillment).

isQualifiersCanBeTargets() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isQualifyFulfillmentAcrossAllItems() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Whether items across the entire order should be considered as potential qualifiers for fulfillment groups instead of just the items in the same fulfillment group.

isQualifyFulfillmentAcrossAllItems() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isRequiresRelatedTargetAndQualifiers() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether a qualifier must be matched to targets that are in its lineage, that is, targets must either be descended from or an ancestor of a qualifier.

isRequiresRelatedTargetAndQualifiers() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isRoundOfferValues() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

Determines whether to round BaseCandidateOffer.potentialSavings.

isRoundOfferValues() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

isRunFulfillmentAndItemOffers() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

Whether Offers of type DiscountTargetType.FULFILLMENT_GROUP or DiscountTargetType.FULFILLMENT_GROUP_ITEM should be run against this order's fulfillment groups and fulfillment items.

isRunOrderAndItemOffers() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

isShowIfOfferApplied() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Determines whether the message should be show to the customer if the associated offer is already applied to the cart.

isSorted() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OffersPermutation

isStackable() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether this offer can be stacked on top of other offers of the same type.

isStackable() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isStackable(Offer, Offer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

isStandardDiscountStrategy(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

isSubscription() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

isTargetAndQualifierProration(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.ProrationType

isTargetOnlyProration(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.ProrationType

isTieredCartSubtotalDiscountStrategy(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

isTieredDiscount() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Deprecated.

since 1.6. Use Offer.isTieredOffer()

isTieredItemQtyDiscountStrategy(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

isTieredItemSubtotalDiscountStrategy(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

isTieredOffer() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

isTotalitarian() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

isTotalitarian() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

isTotalitarian() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

isTotalitarian() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

isTotalitarianItemOfferApplied() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

isTotalitarianOfferApplied() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

Whether any adjustment for this order or it's items is a result of a totalitarian offer, such that it's Offer.getCombinabilityType() is CombinabilityType.NONE.

isTotalitarianOfferApplied() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

isTotalitarianOrderOfferApplied() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

isUseAmountOnlyTierCalculation() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

isUseCartSubtotal() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Determines whether the message should be show based on the current subtotal of the customer's cart.

isUseCustomerEmailAsUserTargetValue() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.autoconfigure.OfferMessagingProperties

When recording OfferAuditDetails, whether to use customer's email on the order as the UserTarget.getTargetValue().

isUseQtyOnlyTierCalculation() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether to match an offer tier's min quantity against the number of items in an order or to match it against the number of target item sets that match an offer's target item criteria.

isUseQtyOnlyTierCalculation() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isUseQtyOnlyTierCalculation() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Determines whether to match an offer tier's min quantity against the number of items in an order or to match it against the number of target item set that match an offer's target item criteria.

isUseSaleAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Whether to use EnhancedLineItem.getSalePrice() in price adjustment calculations.

isUseSalePrice() - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.QualifierLineItemOfferDetailComparator

Determines whether to compare LineItemOfferDetails using their EnhancedLineItem.getSalePrice() instead of EnhancedLineItem.getStandardPrice().

isUseSalePrice() - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

Determines whether to compare LineItemOfferDetails using their EnhancedLineItem.getSalePrice() instead of EnhancedLineItem.getStandardPrice().

isVoucher() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether this is a voucher offer.

isVoucher() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

isVoucherOffer(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

isZeroAmount() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

ITEM_CRITERIA_MAP_COLLECTOR - Static variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

ItemCriteria - Class in com.broadleafcommerce.promotion.offer.domain

Encapsulates all criteria used either to determine if an item is a qualifier or a target.

ItemCriteria() - Constructor for class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

ItemCriteria(String, Set<ItemCriteriaRule>) - Constructor for class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

ItemCriteria(Set<ItemCriteriaRule>) - Constructor for class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

Convenience constructor to initialize rules.

ItemCriteriaRule - Class in com.broadleafcommerce.promotion.offer.domain

Encapsulates a single rule the forms a part of an ItemCriteria.

ItemCriteriaRule() - Constructor for class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

ItemCriteriaRule(int, String) - Constructor for class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

ItemCriteriaRule(String) - Constructor for class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

ItemCriteriaSetConverter - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Converter used for converting a String List type to a JSON String before persistence.

ItemCriteriaSetConverter(ObjectMapper) - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.ItemCriteriaSetConverter

ItemMarketingMessageRequest - Class in com.broadleafcommerce.promotion.offer.domain

Deprecated.

since 1.6, use MarketingMessageRequest instead.

ItemMarketingMessageRequest() - Constructor for class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

itemMarketingMessageResolver - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.ItemMarketingMessageRetrievalEndpoint

Deprecated.

ItemMarketingMessageResolver<P extends MarketingMessage,O extends Offer> - Interface in com.broadleafcommerce.promotion.offer.service

Service API to retrieve MarketingMessages for a EnhancedLineItem based on the Offers the messages to which the messages belong, the locale, the MarketingMessageLocationType, and the MarketingMessageTargetType.

ItemMarketingMessageRetrievalEndpoint - Class in com.broadleafcommerce.promotion.offer.web.endpoint

Deprecated.

since 1.6, use MarketingMessageRetrievalEndpoint instead.

ItemMarketingMessageRetrievalEndpoint(ItemMarketingMessageResolver<MarketingMessage, Offer>, TypeFactory) - Constructor for class com.broadleafcommerce.promotion.offer.web.endpoint.ItemMarketingMessageRetrievalEndpoint

Deprecated.

itemMarketingMessageRetrievalService(MarketingMessageService<P>, MarketingMessageOfferCandidateService<O>) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

ItemOfferAdjustment - Class in com.broadleafcommerce.promotion.offer.web.context.info

DTO containing price adjustment information for a EnhancedLineItem caused by a CandidateItemOffer targeting it.

ItemOfferAdjustment() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

ItemOfferPermutationResult - Class in com.broadleafcommerce.promotion.offer.service.dto

DTO containing results of the evaluation of a permutation of item offers.

ItemOfferPermutationResult(CurrencyUnit) - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

ItemOfferProcessor - Interface in com.broadleafcommerce.promotion.offer.service.engine.application.processor

A service for calculating, determining, and applying the best order item offers.

ItemOfferQtyOneComparator - Class in com.broadleafcommerce.promotion.offer.service.dto.comparator

Compares CandidateItemOffers using Offer.priority then CandidateItemOffer.potentialSavingsQtyOne.

ItemOfferQtyOneComparator() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.comparator.ItemOfferQtyOneComparator

ItemOfferWeightedPercentSavedComparator - Class in com.broadleafcommerce.promotion.offer.service.dto.comparator

Compares CandidateItemOffers using Offer.priority then CandidateItemOffer.weightedPercentSaved.

ItemOfferWeightedPercentSavedComparator() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.comparator.ItemOfferWeightedPercentSavedComparator

ItemRestrictionType - Enum in com.broadleafcommerce.promotion.offer.domain.type

Enumerates the possible ways in which an order item's use by offers can be restricted depending on whether it meets an offer's item qualifier criteria or target item criteria.

J

JpaAttribute - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Persistent counter-part to an Attribute for use with a JPA datastore.

JpaAttribute() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaAttribute

JpaAttribute(Object) - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaAttribute

JpaCampaignTracking - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Persistent counter-part to campaign tracking information for use with a Jpa datastore.

JpaCampaignTracking() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTracking

JpaCampaignTrackingId - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

JpaCampaignTrackingId() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTrackingId

JpaCombinabilityOverride - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Persistent counter-part to a CombinabilityOverride for use with a Jpa datastore.

JpaCombinabilityOverride() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

JpaCombinabilityOverrideId - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

JpaCombinabilityOverrideId() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverrideId

JpaCustomizedMarketingMessageRepository<D extends JpaMarketingMessage> - Class in com.broadleafcommerce.promotion.offer.provider.jpa.repository

JpaCustomizedMarketingMessageRepository(TrackableBehaviorUtil, List<RsqlQueryTransformer>, RSQLVisitor<Predicate, Class<?>>, JpaFiltersCriteriaBuilder) - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

JpaCustomizedOfferAuditDetailRepository<D extends JpaOfferAuditDetail> - Class in com.broadleafcommerce.promotion.offer.provider.jpa.repository

JpaCustomizedOfferAuditDetailRepository(TrackableBehaviorUtil, JpaFiltersCriteriaBuilder) - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferAuditDetailRepository

JpaCustomizedOfferRepository<D extends JpaOffer> - Class in com.broadleafcommerce.promotion.offer.provider.jpa.repository

JpaCustomizedOfferRepository(TrackableBehaviorUtil, JpaFiltersCriteriaBuilder) - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedOfferRepository

JpaDiscountTier - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Persistent counter-part to a DiscountTier for use with a Jpa datastore.

JpaDiscountTier() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

JpaItemCriteriaRule - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Persistent counter-part to an ItemCriteriaRule for use with a Jpa datastore.

JpaItemCriteriaRule() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaItemCriteriaRule

JpaMarketingMessage - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Persistent counter-part to a MarketingMessage for use with a Jpa datastore.

JpaMarketingMessage() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

JpaMarketingMessageRepository<D extends JpaMarketingMessage> - Interface in com.broadleafcommerce.promotion.offer.provider.jpa.repository

jpaMarketingMessageRepositoryImpl(TrackableBehaviorUtil, List<RsqlQueryTransformer>, RSQLVisitor<Predicate, Class<?>>, JpaFiltersCriteriaBuilder) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.autoconfigure.OfferJpaAutoConfiguration

jpaNarrowingHelper - Variable in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

JpaOffer - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Persistent counter-part to a Offer for use with a Jpa datastore.

JpaOffer() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

JpaOfferAuditDetail - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Persistent counter-part to OfferAuditDetail for use with a Jpa datastore.

JpaOfferAuditDetail() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

JpaOfferAuditDetailRepository<D extends JpaOfferAuditDetail> - Interface in com.broadleafcommerce.promotion.offer.provider.jpa.repository

jpaOfferAuditDetailRepositoryImpl(TrackableBehaviorUtil, JpaFiltersCriteriaBuilder) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.autoconfigure.OfferJpaAutoConfiguration

JpaOfferRepository<D extends JpaOffer> - Interface in com.broadleafcommerce.promotion.offer.provider.jpa.repository

jpaOfferRepositoryImpl(TrackableBehaviorUtil, JpaFiltersCriteriaBuilder) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.autoconfigure.OfferJpaAutoConfiguration

JpaRouteConstants - Class in com.broadleafcommerce.promotion.offer.provider.jpa

JpaRouteConstants.Persistence - Class in com.broadleafcommerce.promotion.offer.provider.jpa

JpaSharedCode - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Persistent counter-part to a SharedCode for use with a Jpa datastore.

JpaSharedCode() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

JpaSharedCodeId - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

JpaSharedCodeId() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCodeId

JpaUserTarget - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

Persistent counter-part to UserTarget for use with a Jpa datastore.

JpaUserTarget() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

JpaUserTargetId - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain

JpaUserTargetId() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTargetId

L

LineItemOfferDetail - Class in com.broadleafcommerce.promotion.offer.web.context.info

DTO containing information about the effects of all the offer's applicable to an EnhancedLineItem either treating it as a Offer.getTargetItemCriteria() target} or a Offer.getItemQualifierCriteria() qualifier}.

LineItemOfferDetail() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

LineItemType - Enum in com.broadleafcommerce.promotion.offer.service.dto.type

Enumerates the kinds of LineItems that exist.

listen(Message<String>) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

Event listener entry point.

logDebug(Exception, WebRequest) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

logIfDebugOn(String, Object...) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Checks if debug is enabled, then wraps the message in String.format(String, Object...) with the given formatArgs and logs it.

logIfDebugOn(String, Object...) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

Checks if Log.isDebugEnabled() debug is enabled}, then wraps the message in String.format(String, Object...) with the given formatArgs and logs it.

logIfDebugOn(String, Object...) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Checks if debug is enabled, then wraps the message in String.format(String, Object...) with the given formatArgs and logs it.

logIfDebugOn(String, Object...) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

Checks if Log.isDebugEnabled() debug is enabled}, then wraps the message in String.format(String, Object...) with the given formatArgs and logs it.

logIfTraceOn(String, Object...) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Checks if Log.isTraceEnabled() trace is enabled}, then wraps the message in String.format(String, Object...) with the given formatArgs and logs it.

logIfTraceOn(String, Object...) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultOrderOfferProcessor

Checks if Log.isTraceEnabled() trace is enabled}, then wraps the message in String.format(String, Object...) with the given formatArgs and logs it.

logIfTraceOn(String, Object...) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Checks if Log.isTraceEnabled() debug is enabled}, then wraps the message in String.format(String, Object...) with the given formatArgs and logs it.

lookupOfferQualifierByOffer(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

lookupOfferTargetByOffer(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

M

markAllQualifiers(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Marks which items are qualifiers for each Offer.getItemQualifierCriteria()

markAllTargets(CandidateItemOffer, EnhancedLineItem, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Marks all the items that match a Offer.getTargetItemCriteria().

MarketingMessage - Class in com.broadleafcommerce.promotion.offer.domain

A MarketingMessage encapsulates information necessary for displaying a marketing message related to an Offer next to items affected by the offer in different contexts.

MarketingMessage() - Constructor for class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

MarketingMessageLocationType - Enum in com.broadleafcommerce.promotion.offer.domain.type

Enumeration that determines the locations in which an offer's marketing message should appear.

marketingMessageOfferCandidateService - Variable in class com.broadleafcommerce.promotion.offer.service.DefaultItemMarketingMessageResolver

Deprecated.

marketingMessageOfferCandidateService - Variable in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

marketingMessageOfferCandidateService(OfferCandidateService<P>) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

MarketingMessageOfferCandidateService<P extends Offer> - Interface in com.broadleafcommerce.promotion.offer.service

This service is responsible for finding all the active Offers related to a EnhancedLineItem in order to provide the ItemMarketingMessageResolver to retrieve every relevant MarketingMessage.

MarketingMessageRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable> - Interface in com.broadleafcommerce.promotion.offer.repository

Repository for persistent counter-parts of MarketingMessages.

MarketingMessageRequest - Class in com.broadleafcommerce.promotion.offer.domain

A DTO used to make requests to the MarketingMessageResolver, which finds MarketingMessages.

MarketingMessageRequest() - Constructor for class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

marketingMessageResolver - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessageRetrievalEndpoint

MarketingMessageResolver<P extends MarketingMessage,O extends Offer> - Interface in com.broadleafcommerce.promotion.offer.service

Service API to retrieve MarketingMessages for a MarketingMessageRequest based on the Offers the messages belong to, the MarketingMessageLocationType, and the MarketingMessageTargetType.

MarketingMessageResponse<P extends MarketingMessage> - Class in com.broadleafcommerce.promotion.offer.domain

A DTO to return a list of MarketingMessages.

MarketingMessageResponse() - Constructor for class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

MarketingMessageRetrievalEndpoint - Class in com.broadleafcommerce.promotion.offer.web.endpoint

MarketingMessageRetrievalEndpoint(MarketingMessageResolver<MarketingMessage, Offer>) - Constructor for class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessageRetrievalEndpoint

marketingMessageRetrievalService(MarketingMessageService<P>, OfferCandidateService<O>, MarketingMessageOfferCandidateService<O>, TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

MarketingMessages - Class in com.broadleafcommerce.promotion.offer.domain

A DTO to return a list of MarketingMessages.

MarketingMessages() - Constructor for class com.broadleafcommerce.promotion.offer.domain.MarketingMessages

MarketingMessagesEndpoint - Class in com.broadleafcommerce.promotion.offer.web.endpoint

MarketingMessage is a subresource of Offer, so most of these endpoints fall under the same base URL as OffersEndpoint.

MarketingMessagesEndpoint(MarketingMessageService<MarketingMessage>, OfferService<Offer>, TranslationEntityService<Translation>) - Constructor for class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

marketingMessageService - Variable in class com.broadleafcommerce.promotion.offer.service.DefaultItemMarketingMessageResolver

Deprecated.

marketingMessageService - Variable in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

marketingMessageService(MarketingMessageRepository<Trackable>, RsqlCrudEntityHelper) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

MarketingMessageService<P extends MarketingMessage> - Interface in com.broadleafcommerce.promotion.offer.service

Base service API for MarketingMessage.

MarketingMessageTargetType - Enum in com.broadleafcommerce.promotion.offer.domain.type

Enumerates the types of items a marketing message can target.

MarketingMessageValidator - Class in com.broadleafcommerce.promotion.offer.service.validation

Validations for MarketingMessage.

MarketingMessageValidator() - Constructor for class com.broadleafcommerce.promotion.offer.service.validation.MarketingMessageValidator

markQualifiersAndTargets(EnhancedOrder, CandidateItemOffer, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

markQualifiersAndTargets(EnhancedOrder, CandidateItemOffer, boolean) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.QualifierAndTargetMarker

Marks EnhancedOrder.getOrderLineItems() as either targets or qualifiers for a given CandidateItemOffer.

markQualifiersForSingleCriteria(CandidateItemOffer, ItemCriteriaRule, Collection<? extends EnhancedLineItem>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Marks all the qualifiers for a single Offer.getItemQualifierCriteria().

markRelatedQualifiersAndTargets(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Marks item qualifiers and the target items they qualify for an offer's discount to ensure that all qualifiers have targets and vice versa.

markRelatedQualifiersAndTargetsForItemCriteria(CandidateItemOffer, ItemCriteriaRule, Collection<? extends EnhancedLineItem>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Marks item qualifiers and the target items they qualify for a single Offer.getItemQualifierCriteria() to ensure that all qualifiers have targets and vice versa.

markSingleTargetForItemCriteria(LineItemOfferDetail, CandidateItemOffer, ItemCriteriaRule, int, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Marks a single item as a target of a single Offer.getTargetItemCriteria()

markTargetsForCriteria(CandidateItemOffer, EnhancedLineItem, boolean, ItemCriteriaRule, Collection<? extends EnhancedLineItem>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Marks the targets related to the provided item qualifier ( relatedQualifier) to ensure that there are enough to use for the qualifier's Offer.

matchIsAllowedForItem(EnhancedLineItem, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

Determine whether or not a match is allowed for the line item.

maxUsesPerUserStrategy - Variable in class com.broadleafcommerce.promotion.offer.domain.Offer

Enum that allows implementations to vary how user max uses will be interpreted.

mergeDetails(LineItemOfferDetail, LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

mergeLikeDetails() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Merges any priceDetails that share the same orderAdjustments.

mergePriceDetails(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Checks to see if any LineItemOfferDetails need to be combined and if so, combines them.

mergeProductMessageMaps(Map<String, List<P>>, Map<String, P>, Integer) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

methodType - Variable in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

Determines the method used to apply the discount.

methodType - Variable in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

minAmount - Variable in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

The minimum currency amount to qualify for this tier.

minAmount - Variable in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

minQuantity - Variable in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

The minimum quantity of items needed to reach this tier.

minQuantity - Variable in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

modifyItemCriteria(Offer, ItemCriteria) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

In certain cases (i.e.

MoneyRoundingHelper - Class in com.broadleafcommerce.promotion.offer.service.engine.proration

Helper class to calculate rounding of monetary unit amounts from offer adjustments.

MoneyRoundingHelper() - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.proration.MoneyRoundingHelper

N

NONE - com.broadleafcommerce.promotion.offer.domain.type.CombinabilityType

A.K.A, totalitarian.

NONE - com.broadleafcommerce.promotion.offer.domain.type.ItemRestrictionType

Target Item or Item Qualifier cannot be used in any way by more than 1 offer.

NOT_COMBINABLE - com.broadleafcommerce.promotion.offer.domain.type.CombinabilityOverrideType

Override so that these two offers will not apply within the same order.

O

of(String, BigDecimal) - Static method in class com.broadleafcommerce.promotion.offer.service.dto.DiscountParameters

Offer - Class in com.broadleafcommerce.promotion.offer.domain

An Offer encapsulates information required to provide specialized discount pricing for orders, order items, or related entities This includes not just the discount amount but also important factors such as whether the discount is a percent off, amount off, or fixed price type and whether it should be applied immediately or provided as future credit to the user.

Offer() - Constructor for class com.broadleafcommerce.promotion.offer.domain.Offer

OFFER_ENTITY_MANAGER_FACTORY - Static variable in class com.broadleafcommerce.promotion.offer.provider.jpa.JpaRouteConstants.Persistence

OFFER_ROUTE_KEY - Static variable in class com.broadleafcommerce.promotion.offer.provider.RouteConstants.Persistence

OFFER_ROUTE_PACKAGE - Static variable in class com.broadleafcommerce.promotion.offer.provider.RouteConstants.Persistence

OFFER_TRANSACTION_MANAGER - Static variable in class com.broadleafcommerce.promotion.offer.provider.jpa.JpaRouteConstants.Persistence

OFFER_TRANSACTION_TEMPLATE - Static variable in class com.broadleafcommerce.promotion.offer.provider.jpa.JpaRouteConstants.Persistence

offerApplicationService(ItemOfferProcessor, ItemOfferProcessor, OrderOfferProcessor, FulfillmentGroupOfferProcessor) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OfferApplicationService - Interface in com.broadleafcommerce.promotion.offer.service.engine.application

This service adds adjustments to the order

OfferAuditDetail - Class in com.broadleafcommerce.promotion.offer.domain

Captures audit relevant data when an offer was applied to an order.

OfferAuditDetail() - Constructor for class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

OfferAuditDetailRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable> - Interface in com.broadleafcommerce.promotion.offer.repository

OfferAuditDetailsEndpoint - Class in com.broadleafcommerce.promotion.offer.web.endpoint

OfferAuditDetailsEndpoint(OfferAuditDetailService<OfferAuditDetail>) - Constructor for class com.broadleafcommerce.promotion.offer.web.endpoint.OfferAuditDetailsEndpoint

offerAuditDetailService(OfferAuditDetailRepository<Trackable>, RsqlCrudEntityHelper) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OfferAuditDetailService<P extends OfferAuditDetail> - Interface in com.broadleafcommerce.promotion.offer.service

OfferCacheAutoConfiguration - Class in com.broadleafcommerce.promotion.offer.autoconfigure

Configuration for engaging default Broadleaf support for Apache Ignite cache

OfferCacheAutoConfiguration() - Constructor for class com.broadleafcommerce.promotion.offer.autoconfigure.OfferCacheAutoConfiguration

offerCacheManagerCustomizer(IgniteConfigurers.BasicIgniteConfigurer, OfferCacheProperties) - Method in class com.broadleafcommerce.promotion.offer.autoconfigure.OfferCacheAutoConfiguration

OfferCacheProperties - Class in com.broadleafcommerce.promotion.offer.cache

Properties that influence cache settings for the pricing service

OfferCacheProperties() - Constructor for class com.broadleafcommerce.promotion.offer.cache.OfferCacheProperties

offerCandidateService - Variable in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageOfferCandidateService

offerCandidateService - Variable in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

offerCandidateService - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

offerCandidateService(OfferService<P>, OfferAuditDetailService<? extends OfferAuditDetail>, OfferUserService, CandidateOfferUtility) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OfferCandidateService<P extends Offer> - Interface in com.broadleafcommerce.promotion.offer.service.engine.candidate

This service determines what offers are candidates for a provided order and context.

OfferCheckoutCompletionConsumer - Interface in com.broadleafcommerce.promotion.offer.service.messaging.checkout

Spring cloud data channel description for messaging input.

offerCheckoutCompletionEventListener(IdempotentMessageConsumptionService, OfferAuditDetailService<OfferAuditDetail>, TransactionTemplate, ObjectMapper, TypeFactory, OfferMessagingProperties) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.autoconfigure.OfferMessagingConfiguration

offerCodeUsageValidator - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

OfferCodeUsageValidator - Interface in com.broadleafcommerce.promotion.offer.service.validation

Validator used to run checks against offer codes to determine which codes are still usable.

OfferCombinabilityCriteria - Class in com.broadleafcommerce.promotion.offer.service.dto

This structure allows permutations by offer type to be grouped based on how they are combined with other types and to easily check whether a given set of permutations is compatible with a permutation from another offer type.

OfferCombinabilityCriteria(OfferCombinabilityCriteriaKey) - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

OfferCombinabilityCriteriaKey - Class in com.broadleafcommerce.promotion.offer.service.dto

A structure containing the combinability data for a single offer.

OfferCombinabilityCriteriaKey() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteriaKey

offerContextUtility() - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OfferDefaultsEnvironmentPostProcessor - Class in com.broadleafcommerce.promotion.offer.autoconfigure

Spring Boot default property overrides for this service

OfferDefaultsEnvironmentPostProcessor() - Constructor for class com.broadleafcommerce.promotion.offer.autoconfigure.OfferDefaultsEnvironmentPostProcessor

OfferDiscount - Class in com.broadleafcommerce.promotion.offer.web.context.info

Additional info for all the offers treating an EnhancedLineItem as a target.

OfferDiscount() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

OfferDiscountStrategy - Enum in com.broadleafcommerce.promotion.offer.domain

OfferEngineEndpoint - Class in com.broadleafcommerce.promotion.offer.web.endpoint

OfferEngineEndpoint(OfferAuditDetailService<? extends OfferAuditDetail>, OfferService<? extends Offer>, OfferUserService, OfferEngineService, TypeFactory, OfferCandidateService<? extends Offer>, OfferUsageValidator, OfferCodeUsageValidator, VoucherOfferUsageValidator) - Constructor for class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

OfferEngineResponseBuilder<P extends com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment> - Interface in com.broadleafcommerce.promotion.offer.service.engine

Tool to build a OrderResponse from the information provided via an EnhancedOrder.

offerEngineService - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

offerEngineService(OfferCandidateService, OfferApplicationService, OfferEngineResponseBuilder, ProrationService, OfferProcesingUtility, EntityValidatorManager) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OfferEngineService - Interface in com.broadleafcommerce.promotion.offer.service.engine

This serves as the entry and exist points for the offer engine, which takes in an order and context then determines what offers can apply before calculating the best possible permutation of offers and applying them.

OfferEntityValidationAutoConfiguration - Class in com.broadleafcommerce.promotion.offer.service.autoconfigure

Offer-specific configuration for validation.

OfferEntityValidationAutoConfiguration() - Constructor for class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferEntityValidationAutoConfiguration

offerFactory - Variable in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

offerFactory - Variable in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

offerFactory - Variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultCandidateOfferUtility

offerFactory - Variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

offerFactory - Variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferUserService

offerFactory - Variable in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

OfferItemCriteriaRuleSetConverter - Class in com.broadleafcommerce.promotion.offer.provider.jpa.domain.support

Transforms a Set to and from a JSON object string.

OfferItemCriteriaRuleSetConverter(ObjectMapper) - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.domain.support.OfferItemCriteriaRuleSetConverter

OfferJpaAutoConfiguration - Class in com.broadleafcommerce.promotion.offer.provider.jpa.autoconfigure

OfferJpaAutoConfiguration() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.autoconfigure.OfferJpaAutoConfiguration

OfferMessagingConfiguration - Class in com.broadleafcommerce.promotion.offer.service.messaging.autoconfigure

OfferMessagingConfiguration() - Constructor for class com.broadleafcommerce.promotion.offer.service.messaging.autoconfigure.OfferMessagingConfiguration

OfferMessagingProperties - Class in com.broadleafcommerce.promotion.offer.service.messaging.autoconfigure

OfferMessagingProperties() - Constructor for class com.broadleafcommerce.promotion.offer.service.messaging.autoconfigure.OfferMessagingProperties

OfferProcesingUtility - Class in com.broadleafcommerce.promotion.offer.service.engine

Utility methods used by the offer processing engine extracted for ease of testing.

OfferProcesingUtility() - Constructor for class com.broadleafcommerce.promotion.offer.service.engine.OfferProcesingUtility

OfferProcessingContext - Class in com.broadleafcommerce.promotion.offer.service.dto

This object manages the full list of permutations for a given execution of the offer engine and provides methods to determine the correct mix of offers for the final result.

OfferProcessingContext(EnhancedOrder, CandidateOffers) - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

OfferProperties - Class in com.broadleafcommerce.promotion.offer.provider.jpa.environment

OfferProperties() - Constructor for class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

OfferQualifier - Class in com.broadleafcommerce.promotion.offer.web.context.info

DTO containing information about the order items used by an Offer as item qualifiers.

OfferQualifier() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

OfferRef() - Constructor for class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.OfferRef

OfferRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable> - Interface in com.broadleafcommerce.promotion.offer.repository

offerResponseBuilder() - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OffersEndpoint - Class in com.broadleafcommerce.promotion.offer.web.endpoint

OffersEndpoint(OfferService<Offer>, TranslationEntityService<Translation>) - Constructor for class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

offerService - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

offerService(OfferRepository<Trackable>, RsqlCrudEntityHelper, CacheStateManager, FilterParser<Node>) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OfferService<P extends Offer> - Interface in com.broadleafcommerce.promotion.offer.service

OfferServiceAutoConfiguration - Class in com.broadleafcommerce.promotion.offer.service.autoconfigure

OfferServiceAutoConfiguration(TypeFactory, RuleEvaluationService) - Constructor for class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OffersPermutation<T extends BaseCandidateOffer> - Class in com.broadleafcommerce.promotion.offer.service.dto

DTO containing a set of compatible offers of the same type and that share the same combinability with regard to other types.

OffersPermutation() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.OffersPermutation

offerUsageValidator - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

OfferUsageValidator - Interface in com.broadleafcommerce.promotion.offer.service.validation

Validator used to run checks against offers to determine which offers are still usable.

offerUserService - Variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

offerUserService - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

offerUserService(OfferAuditDetailService<? extends OfferAuditDetail>, CustomerFields) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OfferUserService - Interface in com.broadleafcommerce.promotion.offer.service.engine.candidate

Helper methods around users for offers.

OfferValidator - Class in com.broadleafcommerce.promotion.offer.service.validation

Validations for Offer.

OfferValidator() - Constructor for class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

OfferWebAutoConfiguration - Class in com.broadleafcommerce.promotion.offer.web.autoconfigure

OfferWebAutoConfiguration() - Constructor for class com.broadleafcommerce.promotion.offer.web.autoconfigure.OfferWebAutoConfiguration

ONE_HUNDRED - Static variable in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

ONE_HUNDRED - Static variable in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

ONE_HUNDRED - Static variable in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

ONE_HUNDRED - Static variable in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

ONE_HUNDRED - Static variable in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

ORDER - com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

Determines that the offer's discount should apply to the order's price as a whole rather than individual items separately.

ORDER - com.broadleafcommerce.promotion.offer.service.dto.type.LineItemType

A line item in an EnhancedOrder.

ORDER_DISCOUNT - com.broadleafcommerce.promotion.offer.domain.type.DiscountTimingType

The discount from the offer will be given on the order itself.

ORDER_ITEM - com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

Determines that the offer's discount should apply to individual order items' prices separately.

ORDER_ITEM_ADJUSTMENTS_PATH - Static variable in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

ORDER_STATUS_PATH - Static variable in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

orderAndItemOfferHelper() - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OrderAndItemOfferHelper - Interface in com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper

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

orderItemOfferPotentialSavingsCalculator() - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

orderItemOfferQualifierAndTargetMarker() - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

orderLineItemOfferProcessor(PotentialSavingsCalculator, QualifierAndTargetMarker, OrderAndItemOfferHelper) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

orderMeetsItemTotalRequirements(MonetaryAmount, Map<ItemCriteriaRule, Collection<P>>, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

orderMeetsQualifyingTotalRequirements(BaseCandidateOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

orderMeetsQualifyingTotalRequirements(BaseCandidateOffer) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.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.

orderMeetsSubtotalRequirements(EnhancedOrder, BaseCandidateOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

orderMeetsSubtotalRequirements(EnhancedOrder, BaseCandidateOffer) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.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.

orderMeetsTargetTotalRequirements(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

orderMeetsTargetTotalRequirements(CandidateItemOffer) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.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.

OrderOfferAdjustment - Class in com.broadleafcommerce.promotion.offer.web.context.info

DTO containing price adjustment information for an EnhancedOrder caused by a CandidateOrderOffer targeting it.

OrderOfferAdjustment() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

OrderOfferAdjustment(CandidateOrderOffer, EnhancedOrder, MonetaryAmount, Offer, boolean, RoundingMode, boolean) - Constructor for class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

OrderOfferPermutationResult - Class in com.broadleafcommerce.promotion.offer.service.dto

DTO containing results of the evaluation of a permutation of order offers.

OrderOfferPermutationResult() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.OrderOfferPermutationResult

orderOfferProcessor(OrderAndItemOfferHelper) - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

OrderOfferProcessor - Interface in com.broadleafcommerce.promotion.offer.service.engine.application.processor

A service for calculating, determining, and applying the best order offers.

OrderTotals - Class in com.broadleafcommerce.promotion.offer.service.dto

DTO containing relevant totals such as the order subtotal, discountable subtotals, and other totals needed to determine the best offer.

OrderTotals() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

OrderValidator - Class in com.broadleafcommerce.promotion.offer.web.context.validation

OrderValidator() - Constructor for class com.broadleafcommerce.promotion.offer.web.context.validation.OrderValidator

OTHER_TYPE - com.broadleafcommerce.promotion.offer.domain.type.CombinabilityType

A.K.A., non-combinable.

P

PERCENT_OFF - com.broadleafcommerce.promotion.offer.domain.type.DiscountMethodType

Take a percent off the total amount.

populate(OfferRef) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Populate an OfferRef with the given information on this Offer.

populateAllOffersPermutationFromNode(CombinedTypesOfferPermutation) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatiblePermutationNode

Given a specific node in the tree structure, the compatible list of offers can be found by including the offers from this node and all of its parents.

populateCombinabilityStructures() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

populateCombinabilityStructures(CandidateOffers) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

populateCombinabilityStructuresUsedBySameTargetType(CandidateOffers) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

populateFulfillmentItemsWithOrderItems() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

Populate each of the order's EnhancedFulfillmentGroup.getFulfillmentItems() fulfillment group's fulfillment items} with the corresponding order's order items using EnhancedFulfillmentLineItem.getRelatedOrderLineItemNumber().

populateItemCurrencies() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

populateOrRemoveByFulfillmentGroupTargets(List<CandidateFulfillmentGroupOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

populateOrRemoveByFulfillmentGroupTargets(List<CandidateFulfillmentGroupOffer>) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Filter the provided offer set based on if the provided fulfillment groups of the order match as shipping targets.

populateOrRemoveCandidateOffers(Stream<P>, EnhancedOrder, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

populateOrRemoveCandidateOffers(Stream<P>, EnhancedOrder, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Filter out the provided offer set by matching their configurations against the information on the provided context and order.

populateOrRemoveOffersByFulfillmentGroupQualifiers(List<CandidateFulfillmentGroupOffer>, EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

populateOrRemoveOffersByFulfillmentGroupQualifiers(List<CandidateFulfillmentGroupOffer>, EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Filter the provided offer set based on if the items of the provided order match as qualifiers.

populateOrRemoveOffersByFulfillmentItemQualifiers(List<CandidateItemOffer>, EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

populateOrRemoveOffersByFulfillmentItemQualifiers(List<CandidateItemOffer>, EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Filter the provided offer set based on if the fulfillment items of the provided order match as qualifiers.

populateOrRemoveOffersByFulfillmentItemTargets(List<CandidateItemOffer>, EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

populateOrRemoveOffersByFulfillmentItemTargets(List<CandidateItemOffer>, EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Filter the provided offer set based on if the provided fulfillment items of the order match as shipping targets.

populateOrRemoveOffersByItemTargets(List<CandidateItemOffer>, EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

populateOrRemoveOffersByItemTargets(List<CandidateItemOffer>, EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.candidate.OfferCandidateService

Filter the provided offer set based on if the items of the provided order match as targets.

populateProratedFulfillmentGroupAdjustments(EnhancedFulfillmentGroup) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

Populates the prorated fulfillment group adjustments for the given EnhancedFulfillmentGroup.

populateProratedFulfillmentGroupAdjustments(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

populateProratedFulfillmentGroupAdjustments(EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.OfferEngineService

Populates all of the EnhancedProratedOfferAdjustments for any Offer that has a Discount.getTargetType() of DiscountTargetType.FULFILLMENT_GROUP and add them onto the individual discountable fulfillment items, as well as populating EnhancedFulfillmentGroup.getProratedFulfillmentAdjustments().

populateProratedFulfillmentGroupAdjustments(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

populateProratedFulfillmentGroupAdjustments(EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.proration.ProrationService

Populates all of the EnhancedProratedOfferAdjustments for any Offer that has a Discount.getTargetType() of DiscountTargetType.FULFILLMENT_GROUP and add them onto the individual discountable fulfillment items, as well as populating EnhancedFulfillmentGroup.getProratedFulfillmentAdjustments().

populateProratedFulfillmentGroupAdjustments(FulfillmentGroupAdjustment, EnhancedFulfillmentGroup) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

Populates the prorated fulfillment group adjustments from the given FulfillmentGroupAdjustment across the given fulfillment items and the given EnhancedFulfillmentGroup.

populateProratedItemAdjustments(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

populateProratedItemAdjustments(EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.OfferEngineService

For any Offer that has a Discount.prorationType of ProrationType.TARGET_AND_QUALIFIER, this will populate all of the ProratedItemOfferAdjustments on the LineItemOfferDetails mostly for the sake of reporting instruments.

populateProratedOrderAdjustments(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

populateProratedOrderAdjustments(EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.OfferEngineService

Populates all of the EnhancedProratedOfferAdjustments for any Offer that has a Discount.getTargetType() of DiscountTargetType.ORDER and add them onto the individual discountable order line items.

populateProratedOrderAdjustments(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

populateProratedOrderAdjustments(EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.proration.ProrationService

Populates all of the EnhancedProratedOfferAdjustments for any Offer that has a Discount.getTargetType() of DiscountTargetType.ORDER and add them onto the individual discountable order line items.

populateProratedOrderAdjustments(OrderOfferAdjustment, List<? extends EnhancedLineItem>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

Populates the prorated order adjustments from the given OrderOfferAdjustment across the given line items.

postProcessEnvironment(ConfigurableEnvironment, SpringApplication) - Method in class com.broadleafcommerce.promotion.offer.autoconfigure.OfferDefaultsEnvironmentPostProcessor

potentialSavingsCalculator - Variable in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

PotentialSavingsCalculator - Interface in com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item

This service is responsible for calculating the potential savings for Offer target items if that offer is was the only offer applied.

preFromMe(ContextInfo, Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

preFromMe(ContextInfo, Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

prepareForItemOfferProcessing(OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

Before scoring item offer permutations, it is helpful to prepare the list of offers by calculating potential savings, sorting, and enforcing in order max-uses rules.

prepareForItemOfferProcessing(EnhancedOrder, List<CandidateItemOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

prepareForItemOfferProcessing(EnhancedOrder, List<CandidateItemOffer>) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.ItemOfferProcessor

Item offer processing can benefit from setup activities that are used by all of the permutations.

prepareOfferProcessingContext(EnhancedOrder, CandidateOffers) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

This method takes in a set of candidate offers.

prepareOfferProcessingContext(EnhancedOrder, CandidateOffers) - Method in class com.broadleafcommerce.promotion.offer.service.engine.OfferProcesingUtility

priceGroups() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

Price each of the CandidateFulfillmentGroups according to the BaseCandidateOffer.offer.

processMessage(Message<String>) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

Processes the received message by extracting fields relevant to recording offer code usage and creating OfferAuditDetails

processOfferPermutations(OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

processOfferPermutations(OfferProcessingContext) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.OfferApplicationService

Calculates the value of each offer permutation and determines the best combination of all offer types.

processOfferPermutations(OfferProcessingContext) - Method in class com.broadleafcommerce.promotion.offer.service.engine.DefaultOfferEngineService

PRODUCT_DETAIL - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Means that the marketing message should appear next to applicable items on product detail pages only.

prorateAdjustmentAmongItems(Offer, MonetaryAmount, MonetaryAmount, List<? extends EnhancedLineItem>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

Prorates the given adjustment across the given EnhancedLineItems.

prorationService() - Method in class com.broadleafcommerce.promotion.offer.service.autoconfigure.OfferServiceAutoConfiguration

ProrationService - Interface in com.broadleafcommerce.promotion.offer.service.engine.proration

Calculates all of an Order's order and fulfillment LineItems' ProratedItemOfferAdjustments.

ProrationType - Enum in com.broadleafcommerce.promotion.offer.domain.type

Enumeration to determine whether an offer's discount is divided amongst different types of order items: Whether just "targets" or also "qualifiers".

Q

QUALIFIER - com.broadleafcommerce.promotion.offer.domain.type.ItemRestrictionType

Item Qualifier can be used as a qualifier by other offers but not as a target of other offers.

QUALIFIER_TARGET - com.broadleafcommerce.promotion.offer.domain.type.ItemRestrictionType

Target Item or Item Qualifier can be used as a target or a qualifier by other offers.

qualifierAndTargetMarker - Variable in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

QualifierAndTargetMarker - Interface in com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item

This service is responsible for marking an order's order items as either targets or qualifiers for a given CandidateItemOffer.

QualifierLineItemOfferDetailComparator - Class in com.broadleafcommerce.promotion.offer.service.dto.comparator

Comparator for LineItemOfferDetails being used as qualifiers for offers.

QualifierLineItemOfferDetailComparator() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.comparator.QualifierLineItemOfferDetailComparator

QualifierLineItemOfferDetailComparator(boolean) - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.comparator.QualifierLineItemOfferDetailComparator

QUALIFIERS - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageTargetType

Indicates that an offer's marketing message should be displayed with items that qualify an order or other items for the offer.

R

readAllActiveByCodesIn(Iterable<String>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

readAllActiveByCodesIn(Iterable<String>, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.OfferService

Reads all active offers where Offer.sharedCodes intersects with the provided codes.

readAllActiveByOfferIds(Collection<String>, Node, Pageable, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageService

readAllActiveByOfferIds(Collection<String>, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.MarketingMessageService

readAllActiveByQualifierAndTargetOffersAndRequest(Set<String>, Set<String>, ItemMarketingMessageRequest, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageService

readAllActiveByQualifierAndTargetOffersAndRequest(Set<String>, Set<String>, ItemMarketingMessageRequest, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.MarketingMessageService

Deprecated.

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

readAllActiveByQualifierAndTargetOffersAndRequest(Set<String>, Set<String>, MarketingMessageRequest, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageService

readAllActiveByQualifierAndTargetOffersAndRequest(Set<String>, Set<String>, MarketingMessageRequest, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.MarketingMessageService

Finds marketing messages for the given offers.

readAllAuditDetails(HttpServletRequest, ContextInfo, Pageable, Node) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferAuditDetailsEndpoint

readAllByName(String, Node, Pageable, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

readAllByName(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.OfferService

readAllByOfferId(String, Node, Pageable, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageService

readAllByOfferId(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.MarketingMessageService

readAllCustomerOffersIn(Iterable<UserTarget>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

readAllCustomerOffersIn(Iterable<UserTarget>, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.OfferService

Reads all active offers where Offer.userTargets intersects with the provided UserTargets, or the offer has no UserTargets

readAllMessages(List<String>, ContextInfo, Pageable, Node) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

Reads all of the active MarketingMessages with options for paging and filtering by Offer.id.

readAllMessagesForOffer(String, ContextInfo, Pageable, Node) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

readAllOffers(HttpServletRequest, ContextInfo, String, Pageable, Node) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

readAutomaticAndCodeAndCustomerOffersIn(Iterable<UserTarget>, Iterable<String>, Iterable<String>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

readAutomaticAndCodeAndCustomerOffersIn(Iterable<UserTarget>, Iterable<String>, Iterable<String>, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.OfferService

Reads all active offers where Offer.userTargets intersects with the provided UserTargets, Offer.sharedCodes intersects with the provided codes, Offer.campaignTrackingIds intersects with the provided tracking ids, or Offer.automaticallyConsidered is true.

readMessageById(String, String, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

readOfferAuditDetail(HttpServletRequest, ContextInfo, String) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferAuditDetailsEndpoint

readOfferById(HttpServletRequest, ContextInfo, String) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

readVoucherOffersIn(Iterable<UserTarget>, Iterable<String>, Iterable<String>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.DefaultOfferService

readVoucherOffersIn(Iterable<UserTarget>, Iterable<String>, Iterable<String>, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.OfferService

Reads all voucher offers based on the provided user targets, codes, or tracking ids.

RecordOfferUsageEventListener - Class in com.broadleafcommerce.promotion.offer.service.messaging.checkout

An event listener that triggers when an order is successfully submitted.

RecordOfferUsageEventListener(IdempotentMessageConsumptionService, OfferAuditDetailService<OfferAuditDetail>, TransactionTemplate, ObjectMapper, TypeFactory, OfferMessagingProperties) - Constructor for class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

RecordOfferUsageEventListener.Adjustment - Class in com.broadleafcommerce.promotion.offer.service.messaging.checkout

RecordOfferUsageEventListener.OfferRef - Class in com.broadleafcommerce.promotion.offer.service.messaging.checkout

removeAllAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Removes all orderAdjustments from this detail.

removeAllCandidateAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Remove all of the EnhancedFulfillmentGroup.groupAdjustments for this EnhancedFulfillmentGroup.

removeAllFulfillmentOfferAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

Remove all EnhancedFulfillmentGroup.getGroupAdjustments() for all fulfillment groups.

removeAllGroupOfferAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

removeAllItemOfferAdjustments(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

Remove all adjustments for all order items.

removeAllOrderOfferAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

removeDuplicatePermutations(List<List<CandidateItemOffer>>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

A duplicate permutation means that the permutations have the same offers in the same order.

removeStandardOnlyAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

removeZeroDollarAdjustments() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

removeZeroDollarAdjustments(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

replaceAllMarketingMessageTranslations(ContextInfo, String, String, Locale, TranslationsPayload) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

replaceAllOfferTranslations(ContextInfo, String, Locale, TranslationsPayload) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

replaceMessage(String, String, MarketingMessage, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

replaceOffer(HttpServletRequest, ContextInfo, String, Offer) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

replaceOfferAuditDetail(HttpServletRequest, ContextInfo, String, OfferAuditDetail) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferAuditDetailsEndpoint

resetOfferDetails() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Removes all LineItemOfferDetails except the first, which just gets reset.

resetPriceDetails(TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Clears all EnhancedLineItem.offerDetails and re-initializes them.

resetState() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

Between permutation runs, we need to reset the state of intermediate values

resetUses() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Deprecated.

resolvePermutation() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CompatibleOfferNode

Given a specific node in the tree structure, the compatible list of offers can be found by including the offer from this node and all of its parents.

retrieveCodeUsability(HttpServletRequest, ContextInfo, String) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

rollbackQualifierMarkageBecauseMissingTarget(OfferQualifier, int, LineItemOfferDetail, ItemCriteriaRule) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Undoes marking qualifiers because there were no matching targets.

roundListOfMonetaryAmounts(Map<String, MonetaryAmount>, MonetaryAmount, CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.MoneyRoundingHelper

Given a list of amounts that should round to the provided total, calculates and performs the rounding logic to add the remainder unit amounts.

roundListOfMonetaryAmounts(Map<String, MonetaryAmount>, MonetaryAmount, MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.MoneyRoundingHelper

Given a list of amounts that should round to the provided total, calculates and performs the rounding logic to add the remainder unit amounts.

roundProratedAdjustments(Collection<D>, MonetaryAmount, CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.MoneyRoundingHelper

Rounds the given EnhancedProratedOfferAdjustments.

roundProratedFulfillmentGroupAdjustments(EnhancedFulfillmentGroup, Collection<D>, MonetaryAmount, CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.MoneyRoundingHelper

Rounds the given EnhancedFulfillmentGroup.getProratedFulfillmentAdjustments() and EnhancedProratedOfferAdjustments.

RouteConstants - Class in com.broadleafcommerce.promotion.offer.provider

RouteConstants.Persistence - Class in com.broadleafcommerce.promotion.offer.provider

rsqlQueryTransformers - Variable in class com.broadleafcommerce.promotion.offer.provider.jpa.repository.JpaCustomizedMarketingMessageRepository

ruleEvaluationService - Variable in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageOfferCandidateService

ruleEvaluationService - Variable in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

ruleEvaluationService - Variable in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.DefaultOrderAndItemOfferHelper

ruleEvaluationService - Variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

S

scoreFulfillmentGroupOfferPermutations(OfferProcessingContext, CombinedTypesOfferPermutation) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

scoreFulfillmentItemOfferPermutations(OfferProcessingContext, CombinedTypesOfferPermutation) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

scoreItemOfferPermutations(OfferProcessingContext, CombinedTypesOfferPermutation) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

scoreOrderOfferPermutations(OfferProcessingContext, CombinedTypesOfferPermutation) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.DefaultOfferApplicationService

SEARCH - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Deprecated.

as of 1.6, use MarketingMessageLocationType.BROWSE instead

segment - Variable in class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

Name of the field passed in as part of UserTarget.targetType that maps to the customer segment.

service - Variable in class com.broadleafcommerce.promotion.offer.service.engine.candidate.DefaultOfferCandidateService

service - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferAuditDetailsEndpoint

set_id(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

set_id(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setAccount(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

Name of the field passed in as part of UserTarget.targetType that maps to the account.

setActiveEndDate(Instant) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Defines the ending time for which this message is active

setActiveEndDate(Instant) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Defines the ending time for which this offer is active.

setActiveEndDate(Instant) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setActiveEndDate(Instant) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setActiveStartDate(Instant) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Defines the beginning time for which this message is active

setActiveStartDate(Instant) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Defines the beginning time for which this offer is active.

setActiveStartDate(Instant) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setActiveStartDate(Instant) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setAdjustedSubtotal() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setAdjustedSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setAdjustedTotal() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setAdjustedTotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The total value of all LineItemOfferDetail.adjustments times the LineItemOfferDetail.quantity of this detail.

setAdjustments(Map<String, List<FulfillmentGroupAdjustment>>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

setAdjustments(Set<ItemOfferAdjustment>) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The ItemOfferAdjustments caused by offers treating the LineItemOfferDetail.lineItem as a target.

setAdjustmentsFinalized(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Whether the LineItemOfferDetail.adjustments are the orderAdjustments to actually use rather than being potential or incomplete.

setAdjustmentValue(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The final amount by which to adjust the order item's price.

setAllCandidateOffers(List<BaseCandidateOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

A set of all the relevant candidate offers for given offer engine execution

setAllFulfillmentGroupPermutations(Set<OffersPermutation>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setAllFulfillmentItemPermutations(Set<OffersPermutation>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setAllItemPermutations(Set<OffersPermutation>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setAllOfferIds(Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

Set of ids for all offers that are applicable to a given offer engine execution.

setAllOrderPermutations(Set<OffersPermutation>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setAllVoucherPermutations(Set<OffersPermutation>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setAmount(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

The discount amount that this discount represents.

setAmount(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

The discount amount that this tier represents.

setAmount(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

The amount of the adjustment applied to the item.

setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

The amount of the prorated adjustment for the item.

setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

setApplicableToDependentItems(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Whether this discount should apply to an item's dependent order items (e.g., add-ons).

setApplicableToSalesPrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Whether this discount should apply to an item's sale price or just its non-sale price(s).

setAppliedOfferIds(List<String>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

A list of currently applied offer ids

setAppliedToSalePrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

Whether the ItemOfferAdjustment.adjustmentValue was applied to EnhancedLineItem.getStandardPrice() or EnhancedLineItem.getSalePrice().

setApplyToFuturePeriods(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

Whether an offer should be applied to items' future periods, i.e., items that have a recurring billing cycle based on a frequency and a period.

setApplyToFuturePeriods(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setAttributes(Map<String, Attribute>) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Dynamic attributes that are a part of the offer.

setAttributes(Map<String, JpaAttribute>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setAutomaticallyConsidered(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether this offer should be considered to be applied without needing any Offer.sharedCodes or Offer.campaignTrackingIds (or some other, similar constraint).

setAutomaticallyConsidered(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setBeginPeriod(int) - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

The beginning period for which this offer should be applied.

setBeginPeriod(Integer) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setBestFulfillmentGroupOfferPermutation(FulfillmentGroupOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setBestFulfillmentItemOfferPermutation(ItemOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setBestItemOfferPermutation(ItemOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setBestOfferPermutation(CombinedTypesOfferPermutation) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

setBestOrderOfferPermutation(OrderOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setBestVoucherOfferPermutation(OffersPermutation) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setBrowseItemMessages(Map<String, List<P>>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

Messages that should be displayed on individual product items shown during browse

setBrowseMessages(List<P>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

Messages that should be displayed on the product list page headers

setBundleRatio(double) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The ratio of the offer discount to apply to this item.

setCampaignTrackingIds(Set<JpaCampaignTracking>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setCampaignTrackingIds(Set<String>) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The tracking identifiers of the campaigns of which this offer is a part.

setCandidateFulfillmentGroup(CandidateFulfillmentGroup) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

setCandidateFulfillmentGroupOffer(CandidateFulfillmentGroupOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

setCandidateFulfillmentGroupOffers(List<CandidateFulfillmentGroupOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

List of candidate offers targeting fulfillment groups.

setCandidateFulfillmentGroups(List<CandidateFulfillmentGroup>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

The CandidateFulfillmentGroups that can be targeted by BaseCandidateOffer.offer, each one representing a decorated EnhancedFulfillmentGroup with savings information.

setCandidateFulfillmentItemOffers(List<CandidateItemOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

List of candidate offers targeting fulfillment items.

setCandidateItemOffer(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The CandidateItemOffer DTO related to ItemOfferAdjustment.offer.

setCandidateItemOffer(CandidateItemOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

The CandidateItemOffer DTO related to OfferDiscount.offer.

setCandidateItemOffers(CandidateOffers, List<CandidateItemOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

setCandidateOffers(List<T>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OffersPermutation

setCandidateOrderItemOffers(List<CandidateItemOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

List of candidate offers targeting order items.

setCandidateOrderOffer(CandidateOrderOffer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

setCandidateOrderOffers(List<CandidateOrderOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

List of candidate offers targeting orders.

setCandidateQualifiersMap(Map<ItemCriteriaRule, Collection<EnhancedFulfillmentLineItem>>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedFulfillmentLineItem that meet that criteria for this CandidateFulfillmentGroup.fulfillmentGroup.

setCandidateQualifiersMap(Map<ItemCriteriaRule, Collection<EnhancedLineItem>>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedLineItem that meet that criteria.

setCandidateQualifiersMap(Map<ItemCriteriaRule, Collection<EnhancedLineItem>>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

Map of ItemCriteriaRule from an offer's item qualifier criteria to a Collection of EnhancedLineItem that meet that criteria.

setCandidateTargetsMap(Map<ItemCriteriaRule, Collection<EnhancedLineItem>>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Map of ItemCriteriaRule from an offer's target item criteria to a Collection of EnhancedLineItem that meet that criteria.

setCartItemMessages(Map<String, List<P>>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

Messages that should be displayed on individual cart items

setCartLabel(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

A label for this offer typically used by the storefront.

setCartLabel(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setCartMessages(List<P>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

Messages that should be displayed on the cart page's header

setCartProductIds(List<String>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The ids of any products currently in the customer's cart

setCartSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The subtotal of the customer's cart

setCartSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The minimum cart subtotal to apply this offer.

setCartSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setCartSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setCategoryId(String) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The current category's id

setChildren(Set<EnhancedOrderLineItem>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

Not part of the incoming or outgoing payloads but populated at the start of the offer engine in order to provide faster lookup during processing.

setCode(String) - Method in class com.broadleafcommerce.promotion.offer.domain.SharedCode

The code string associated to this shared code and used to apply the associated offer to an order.

setCode(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

setCodes(Codes) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

DTO containing codes used to apply offers to orders.

setCodes(Codes) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setCodeUsed(String) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.Adjustment

setCombinabilityOverrides(Set<CombinabilityOverride>) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The CombinabilityOverrides that override how this offer combines with other offers.

setCombinabilityOverrides(Set<JpaCombinabilityOverride>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setCombinabilityType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether this offer can be combined with other offers.

setCombinabilityType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setCombinableOverrides(Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

Convert offer data into easier structures for combinability algorithms

setCompatibleOffers(Set<BaseCandidateOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

setCompatibleWithOtherTypes(boolean) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteriaKey

setConnectiveOperator(String) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

The connective with which to join all of the ItemCriteria.rules together.

setContextId(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setContextId(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setContextId(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

setContextInfo(ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The ContextInfo derived from the original request containing tenant and sandbox info.

setContextState(EmbeddedContextState) - Method in class com.broadleafcommerce.promotion.offer.domain.Attribute

A subset of Tracking information to expose the context state for this object.

setContextState(EmbeddedContextState) - Method in class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

A subset of Tracking information to expose the context state for this object.

setContextState(EmbeddedContextState) - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

A subset of Tracking information to expose the context state for this object.

setContextState(EmbeddedContextState) - Method in class com.broadleafcommerce.promotion.offer.domain.SharedCode

A subset of Tracking information to expose the context state for this object.

setContextState(EmbeddedContextState) - Method in class com.broadleafcommerce.promotion.offer.domain.UserTarget

A subset of Tracking information to expose the context state for this object.

setContextState(ContextState) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

A subset of Tracking information to expose the context state for this object.

setContextState(ContextState) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

A subset of Tracking information to expose the context state for this object.

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

Transient property that holds the currency used to convert price to a MonetaryAmount.

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

Transient property that holds the currency used to convert price to a MonetaryAmount.

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

The EnhancedOrder.getCurrency() order's currency code}.

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setCustomer(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

Name of the field passed in as part of UserTarget.targetType that maps to the individual customer.

setCustomerContext(CustomerContext) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

setCustomerContext(CustomerContext) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The customer context information that should be used in determiningwhich offers apply

setCustomerContext(CustomerContext) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setDatasource(DataSourceProperties) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

setDateApplied(Instant) - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The date and time when the related offer was applied.

setDateApplied(Instant) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

setDelegating(SchemaDelegatingProperties) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

setDescription(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Description of this offer.

setDescription(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setDestination(Destination) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setDiscount(Discount) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Basic discount information for this offer.

setDiscountable(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

setDiscountablePriceForOrder(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

setDiscountAmount(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setDiscountApplicableToDependentItems(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setDiscountApplicableToSalesPrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setDiscountCurrentOrder(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

Whether to apply this discount to the current provided order.

setDiscountCurrentOrder(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setDiscountedAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

The amount off this fulfillment group would get if the candidate offer was applied.

setDiscountedTotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

The adjusted discounted price for this candidate fulfillment group if the candidate offer was applied.

setDiscountMethodType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setDiscountProrationType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setDiscountTargetType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setDiscountTiers(List<DiscountTier>) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

List of discount tiers determining the discount applied with this offer.

setDiscountTiers(List<JpaDiscountTier>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setDiscountTimingType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setDisplayHint(String) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Defines a hint to the client on how to display this message

setDisplayHint(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setDistributeOfferAmountToTargets(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

This property impacts the way that items share the same discount.

setDistributeOfferAmountToTargets(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setEndPeriod(int) - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

The ending period for which this offer should be applied.

setEndPeriod(Integer) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setEstimatedValue(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Provide an estimated value for this offer.

setEstimatedValue(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

Estimated value for this offer, used in scoring the best offer permutation for voucher and free gift offers.

setFaxNumber(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setFinalizedQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

The actual item quantity of an EnhancedLineItem matched to the OfferDiscount.offer.

setFinalizedQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

The actual item quantity of an EnhancedLineItem matched to the OfferQualifier.offer.

setFinalPrice(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

The final price, including adjustments, for a single merchandising item represented by this order line item.

setFreeGift(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether this is a free gift offer.

setFreeGift(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setFreeGiftItems(List<FreeGiftItem>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setFreeProduct(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Defines the id of the free product for this offer.

setFreeProduct(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setFulfillmentGroup(EnhancedFulfillmentGroup) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

The EnhancedFulfillmentGroup that is decorated for consideration as part of a CandidateFulfillmentGroupOffer.

setFulfillmentGroupCriteria(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

String expression used to determine if a fulfillment group qualifies for this offer.

setFulfillmentGroupCriteria(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setFulfillmentGroups(List<EnhancedFulfillmentGroup>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setFulfillmentItems(List<EnhancedFulfillmentLineItem>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setFulfillmentOptionName(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setFulfillmentOptionType(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setFutureCredit(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

setFutureCredit(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

Future credit means that the associated adjustment will be discounted at a later time to the customer via a credit.

setFutureCredit(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

setGroupAdjustments(List<FulfillmentGroupAdjustment>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setId(String) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

setId(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The context ID of the offer.

setId(String) - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The context ID of the offer audit detail

setId(String) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.OfferRef

setId(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setId(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Matches the line number unless the line number isn't available in which case it will represent a uuid.

setItem(EnhancedLineItem) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

setItemQualifierCriteria(ItemCriteria) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Info related to determining what items are required so that an order or other items qualify to receive this offer's discount.

setItemQualifierCriteria(ItemCriteriaRule) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

The Offer.getItemQualifierCriteria() that an EnhancedLineItem matched.

setJpa(JpaProperties) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

setKey(OfferCombinabilityCriteriaKey) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

setLineItem(LineItemRef) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

The LineItemRef of the EnhancedLineItem that gets this adjustment.

setLineItem(LineItemRef) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

The LineItemRef of the EnhancedLineItem that gets this adjustment.

setLineItem(EnhancedLineItem) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The EnhancedLineItem affected by offers.

setLineItemOfferDetail(LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

setLineItems(List<EnhancedLineItem>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

A list of hydrated EnhancedLineItems used by the MarketingMessageResolver to retrieve MarketingMessages

setLineNumber(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

setLiquibase(LiquibaseProperties) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

setLocale(Locale) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

setLocale(Locale) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Deprecated.

since 1.6 use translations for different locales

setLocale(Locale) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

Deprecated.

setLocale(Locale) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setLocationType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

setLocationType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Deprecated.

since 1.6 functionality moved to MarketingMessage.locationTypes.

setLocationType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

Deprecated.

setLocationTypes(List<String>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Determines in what locations this message can appear, whether on product detail, browse, search, or cart pages or everywhere.

setLocationTypes(List<String>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setMaxCartSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

The maximum cart subtotal to display this message.

setMaxCartSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setMaxMessageCount(Integer) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The maximum number of messages for each location and location / product combination

setMaxSavingsPerOrder(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the maximum savings a single order can receive from this offer.

setMaxSavingsPerOrder(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setMaxUses(int) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the maximum number of times this offer can be used.

setMaxUses(int) - Method in class com.broadleafcommerce.promotion.offer.domain.SharedCode

Defines the maximum number of times that this code can be used regardless of Order or Customer.

setMaxUses(int) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setMaxUses(int) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

setMaxUsesPerOrder(int) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the maximum number of times this offer can be used on a single order.

setMaxUsesPerOrder(int) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setMaxUsesPerUser(int) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the maximum number of times this offer can be used by the same user.

setMaxUsesPerUser(int) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setMaxUsesPerUserFrequency(int) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

This field works in conjunction with Offer.maxUsesPerUser to limit the frequency with which an individual user can use this offer.

setMaxUsesPerUserFrequency(int) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setMaxUsesPerUserStrategy(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Enum that allows implementations to vary how user max uses will be interpreted.

setMaxUsesPerUserStrategy(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setMessages(List<MarketingMessage>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessages

setMethodType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Determines the method used to apply the discount.

setMethodType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

Determines the method used to apply the discount.

setMethodType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

setMinAmount(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

The minimum currency amount to qualify for this tier.

setMinAmount(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

setMinCartSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

The minimum cart subtotal to display this message.

setMinCartSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setMinQuantity(Long) - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

The minimum quantity of items needed to reach this tier.

setMinQuantity(Long) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

setMinTotalOfQualifierPrices(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the price subtotal threshold that all qualifying items must reach in addition to Offer.itemQualifierCriteria in order to qualify an order items to receive this offer's discount.

setMinTotalOfQualifierPrices(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setMinTotalOfTargetPrices(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines the price subtotal threshold that all targeted items must reach in addition to Offer.targetItemCriteria in order to receive this offer's discount.

setMinTotalOfTargetPrices(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setMoneyRoundingHelper(MoneyRoundingHelper) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

setName(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Display name for this offer.

setName(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setNonCombinableOverrides(Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

setNumberOfMatchesRequired(int) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

Determines the number of items that must match the ItemCriteriaRule.rule in order for this criteria to be met.

setNumberOfMatchesRequired(int) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaItemCriteriaRule

setOffer(OfferRef) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

The OfferRef for the Offer that caused this adjustment to be applied.

setOffer(OfferRef) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

The OfferRef for the offer where this prorated adjustment is from.

setOffer(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

The candidate Offer.

setOffer(Offer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

setOffer(Offer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The Offer targeting some EnhancedLineItem.

setOffer(Offer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

The Offer targeting some EnhancedLineItem.

setOffer(Offer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

The Offer using some EnhancedLineItem as an item qualifier.

setOffer(Offer) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

setOffer(JpaOffer) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTracking

setOffer(JpaOffer) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

setOffer(JpaOffer) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

setOffer(JpaOffer) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

setOfferByAutomatic(Duration) - Method in class com.broadleafcommerce.promotion.offer.cache.OfferCacheProperties

setOfferByUserTargets(Duration) - Method in class com.broadleafcommerce.promotion.offer.cache.OfferCacheProperties

setOfferCombinabilityCriteriaKey(OfferCombinabilityCriteriaKey) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

Holds the combinability criteria for this offer.

setOfferContextId(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setOfferDetails(List<LineItemOfferDetail>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

DTOs containing information about offers applicable to this item.

setOfferDiscounts(Set<OfferDiscount>) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Additional info for all the offers treating the LineItemOfferDetail.lineItem as a target.

setOfferDiscountStrategy(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Represents the discount strategy for this offer.

setOfferDiscountStrategy(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setOfferId(String) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Id of the parent Offer.

setOfferId(String) - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The associated offer's id.

setOfferId(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

setOfferQualifiers(Set<OfferQualifier>) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Additional information about the offers using the LineItemOfferDetail.lineItem as item qualifiers.

setOfferRef(RecordOfferUsageEventListener.OfferRef) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.Adjustment

setOfferTargetType(String) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OffersPermutation

setOfferUses(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The number of times that the offer this adjustment was created from is applied.

setOrder(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

The order being targeted by BaseCandidateOffer.getOffer() }.

setOrder(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

setOrderAdjustments(List<OrderOfferAdjustment>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setOrderCriteria(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

String expression used in conjunction with Offer.itemQualifierCriteria to determine if an order qualifies for this offer.

setOrderCriteria(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setOrderId(String) - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The id of the order upon which the related offer was used.

setOrderId(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

setOrderLineItem(EnhancedOrderLineItem) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentLineItem

The corresponding EnhancedOrderLineItem for this EnhancedFulfillmentLineItem.

setOrderLineItems(List<EnhancedOrderLineItem>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setOrderNumber(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setOrderSubmitDate(Instant) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setOrderTotals(OrderTotals) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

setOriginalPrice(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

The original, unadjusted price of the item being targeted by BaseCandidateOffer.getOffer().

setOtherTypeOfferIdsList(Map<String, Set<String>>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

For combinability algorithms, it is helpful to know the ids of all other offer types.

setOverrideType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

The type of override being performed for this offer combination.

setOverrideType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

setParent(EnhancedOrderLineItem) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

Not part of the incoming or outgoing payloads but populated at the start of the offer engine in order to provide faster lookup during processing.

setParentDetail(LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

setParentDetail(LineItemOfferDetail) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

setParentLineNumber(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

setPermutations(Set<OffersPermutation>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

setPermutationTotals(OrderTotals) - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

setPermutationTotals(OrderTotals) - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

setPermutationTotals(OrderTotals) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderOfferPermutationResult

setPotentialSavings(CandidateItemOffer, MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

setPotentialSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

The total potential amount saved by applying this offer to its targets.

setPotentialSavingsQtyOne(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Potential savings per single use of BaseCandidateOffer.getOffer().

setPreferCartBundling(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

This property provides a hint to the front-end application to perform grouping for items that share the same discount.

setPreferCartBundling(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setPrice(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

Tracks the discount amount of the related item qualifier.

setPriceBeforeAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setPrimaryPhone(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setPriority(Integer) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

When multiple messages match a context, the message with the higher priority wins out, where smaller integer values represent higher priorities.

setPriority(Integer) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setPriority(Long) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

When multiple offers match a context, the offer with the higher priority is applied first, where smaller integer values represent higher priorities.

setPriority(Long) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setProductDetailMessages(Map<String, List<P>>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

Messages that should be displayed on product detail pages

setProductIds(List<String>) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

The ids for all products to retrieve marketing messages for

setProratedAdjustments(List<ProratedOfferAdjustment>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

Prorated offer adjustment information for this line item.

setProratedAdjustments(Set<EnhancedProratedItemOfferAdjustment>) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The ProratedItemOfferAdjustments caused by offers with Discount.getProrationType() or ProrationType.TARGET_AND_QUALIFIER treating both LineItemOfferDetail.lineItem as a target and the items that qualify it.

setProratedFulfillmentAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Prorated fulfillment adjustments for the fulfillment group itself.

setProrationType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Determines how an offer's discount amount is distributed across the offer's related order item types.

setQualifierDetails(List<OfferItemDetail>) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

A list of OfferItemDetails representing the qualifier items where this adjustment was from.

setQualifierItemCriteriaConnectiveOperator(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setQualifierItemCriteriaRules(Set<ItemCriteriaRule>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setQualifiersCanBeQualifiers(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether items that qualify an order to receive this offer's discount can also be used as qualifiers for other offers of the same type (e.g., Order, Order Item, Fulfillment).

setQualifiersCanBeQualifiers(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setQualifiersCanBeTargets(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether items that qualify an order to receive this offer's discount can also receive discounts from other offers of the same type (e.g., Order, Order Item, Fulfillment).

setQualifiersCanBeTargets(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setQualifyFulfillmentAcrossAllItems(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Whether items across the entire order should be considered as potential qualifiers for fulfillment groups instead of just the items in the same fulfillment group.

setQualifyFulfillmentAcrossAllItems(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

The quantity of merchandising items from the EnhancedLineItem to which this adjustment applies.

setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

The quantity of items related to this detail.

setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

The potential item quantity of an EnhancedLineItem that matched the OfferDiscount.offer.

setQuantity(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

The potential item quantity of an EnhancedLineItem that matched the OfferQualifier.offer.

setQuantityPerUsage(int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The quantity per offer usage of the item where this adjustment is applied to (target item).

setRelatedOfferRef(String) - Method in class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

The id of an offer for which combinability is being overridden for this offer.

setRelatedOfferRef(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

setRelatedOrderLineItemNumber(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentLineItem

setRequiresRelatedTargetAndQualifiers(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether a qualifier must be matched to targets that are in its lineage, that is, targets must either be descended from or an ancestor of a qualifier.

setRequiresRelatedTargetAndQualifiers(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setRoundingMode(RoundingMode) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

The RoundingMode to use when rounding.

setRoundingMode(RoundingMode) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

setRoundOfferValues(boolean) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

Determines whether to round BaseCandidateOffer.potentialSavings.

setRoundOfferValues(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

setRule(String) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

String expression used to determine which items must be present so that an order may receive this offer's discount.

setRule(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaItemCriteriaRule

setRules(Set<ItemCriteriaRule>) - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

Rules that comprise this criteria.

setRunOrderAndItemOffers(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setSaleAdjustmentValue(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The amount by which to adjust the EnhancedLineItem.getSalePrice().

setSalePrice(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

setSecondaryPhone(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

setSegment(String) - Method in class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

Name of the field passed in as part of UserTarget.targetType that maps to the customer segment.

setSharedCode(String) - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The string of the shared code used to apply the related offer if one was used.

setSharedCode(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

setSharedCodes(Set<SharedCode>) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The SharedCodes that can be used to retrieve this offer.

setSharedCodes(Set<JpaSharedCode>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setShowIfOfferApplied(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Determines whether the message should be show to the customer if the associated offer is already applied to the cart.

setShowIfOfferApplied(Boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setSorted(boolean) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OffersPermutation

setStackable(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether this offer can be stacked on top of other offers of the same type.

setStackable(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setStackableOverrides(Set<String>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

setStandardAdjustmentValue(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

The amount by which to adjust the EnhancedLineItem.getStandardPrice().

setStandardPrice(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

setSubscription(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

setSubscriptionDiscount(SubscriptionDiscount) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Information around discounting subscription items that have recurring billing.

setSubTotalWithAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

setTargetGroupingStrategy(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

The target grouping strategy.

setTargetGroupingStrategy(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setTargetGroupingStrategy(String) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

The target grouping strategy.

setTargetItemCriteria(ItemCriteria) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Info related to determining what order items can receive this offer's discount.

setTargetItemCriteria(ItemCriteriaRule) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

The Offer.getTargetItemCriteria() that an EnhancedLineItem matched.

setTargetItemCriteriaConnectiveOperator(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setTargetItemCriteriaRules(Set<ItemCriteriaRule>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setTargetType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Determines the type of entity that receives the discount.

setTargetType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Determines whether this message should appear only next to its offer's targets or qualifiers or next to both.

setTargetType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.UserTarget

The type of the user.

setTargetType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setTargetType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

setTargetType(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

setTargetType(String) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteriaKey

setTargetValue(String) - Method in class com.broadleafcommerce.promotion.offer.domain.UserTarget

An identifying value for the user.

setTargetValue(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

setTargetValue(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

setText(String) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

The actual text of the message to display.

setText(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setTieredDiscount(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Deprecated.

See Offer.offerDiscountStrategy. Offers with this value set to true are now considered to have a discount strategy of OfferDiscountStrategy.TIERED_ITEM_QTY. To check if an offer is tiered, use Offer.isTieredOffer()

setTieredDiscount(Boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

Deprecated.

setTimeCriteria(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

String expression used to determine whether this offer can be qualified for only at certain times or on certain days or months.

setTimeCriteria(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setTimeOfRequest(Instant) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setTimingType(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

Determines the timing of the discount's application.

setTotalAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

setTotalAdjustments(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.OrderTotals

setTotalFufillmentCharges(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setTotalSavings(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

Total savings across all CandidateFulfillmentGroupOffer.candidateFulfillmentGroups for the BaseCandidateOffer.offer.

setTracking(ApplicationJpaTracking) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setTracking(ApplicationJpaTracking) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setTracking(TenantJpaTracking) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

setTrackingId(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTracking

setUseAmountOnlyTierCalculation(boolean) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

setUseCartSubtotal(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

Determines whether the message should be show based on the current subtotal of the customer's cart.

setUseCartSubtotal(Boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

setUseCustomerEmailAsUserTargetValue(boolean) - Method in class com.broadleafcommerce.promotion.offer.service.messaging.autoconfigure.OfferMessagingProperties

When recording OfferAuditDetails, whether to use customer's email on the order as the UserTarget.getTargetValue().

setUseQtyOnlyTierCalculation(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether to match an offer tier's min quantity against the number of items in an order or to match it against the number of target item sets that match an offer's target item criteria.

setUseQtyOnlyTierCalculation(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setUseQtyOnlyTierCalculation(boolean) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Determines whether to match an offer tier's min quantity against the number of items in an order or to match it against the number of target item set that match an offer's target item criteria.

setUser(UserTarget) - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

The identifying info of the user that used the related offer.

setUserTargets(Set<UserTarget>) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Set of users directly targeted by this offer.

setUserTargets(Set<JpaUserTarget>) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setUses(int) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Tracks the number of times this candidate offer has been used.

setUseSaleAdjustments(boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Whether to use EnhancedLineItem.getSalePrice() in price adjustment calculations.

setUseSalePrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.QualifierLineItemOfferDetailComparator

Determines whether to compare LineItemOfferDetails using their EnhancedLineItem.getSalePrice() instead of EnhancedLineItem.getStandardPrice().

setUseSalePrice(boolean) - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

Determines whether to compare LineItemOfferDetails using their EnhancedLineItem.getSalePrice() instead of EnhancedLineItem.getStandardPrice().

setValue(Object) - Method in class com.broadleafcommerce.promotion.offer.domain.Attribute

The value represented by this attribute.

setValue(Object) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaAttribute

setVoucher(boolean) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Determines whether this is a voucher offer.

setVoucher(boolean) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setVoucherCampaign(String) - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

Defines the id of the campaign for this offer.

setVoucherCampaign(String) - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

setVouchers(List<Voucher>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

setWeightedDiscountPercent(CandidateItemOffer, BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

setWeightedPercentSaved(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

Takes the BaseCandidateOffer.getPotentialSavings() and divides them by the item's price before multiply by 100 to get a percentage.

setWeightedSavingsPercentage(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

SharedCode - Class in com.broadleafcommerce.promotion.offer.domain

A simple structure that can be used to represent a code that applies an offer to an order.

SharedCode() - Constructor for class com.broadleafcommerce.promotion.offer.domain.SharedCode

sharedCodeValuesToSharedCodeEntities() - Static method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

shouldCalculateSimplePercent(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

shouldProrateAdjustment(FulfillmentGroupAdjustment) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

Determines whether the given FulfillmentGroupAdjustment should be prorated across the fulfillment items.

shouldProrateAdjustment(OrderOfferAdjustment) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

Determines whether the given OrderOfferAdjustment should be prorated across the order line items.

sort(List<CandidateItemOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

The default based on the CandidateItemOfferComparator

sortAndFilter(List<CandidateFulfillmentGroupOffer>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

sortGroups() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

Sort the CandidateFulfillmentGroups according to best discount.

sortOfferDetailsForQualifiers(List<LineItemOfferDetail>, boolean) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Sorts LineItemOfferDetails in preparation for marking qualifier items for offers.

sortOfferDetailsForTargets(List<LineItemOfferDetail>, boolean, String) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultQualifierAndTargetMarker

Sorts LineItemOfferDetails in preparation for marking targets items for offers.

split(TypeFactory, int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

Checks to see that the discount quantities match the target quantities.

split(TypeFactory, int) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

Checks to see that the discount quantities match the target quantities.

split(TypeFactory, int, String, boolean) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Deprecated.

since 1.6, in favor of LineItemOfferDetail.split(TypeFactory, OfferDiscount).

split(TypeFactory, OfferDiscount) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Splits this item into two LineItemOfferDetails and returns the newly created LineItemOfferDetail.

splitDetailsIfNecessary(List<LineItemOfferDetail>) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

Checks if the discount quantity matches the detail quantity.

splitIfNecessary(TypeFactory) - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

Checks to see that the discount quantities match the target quantities.

STACKABLE - com.broadleafcommerce.promotion.offer.domain.type.CombinabilityOverrideType

Specify that this offer can be stacked with the other offer such that discounts from both offers will apply.

STANDARD - com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

The standard discount strategy.

storeLineItemDetails(Map<String, List<LineItemOfferDetail>>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

SUBMITTED - Static variable in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

SubscriptionDiscount - Class in com.broadleafcommerce.promotion.offer.domain

Encapsulates all of the fields relevant to an offer's subscription compatibility.

SubscriptionDiscount() - Constructor for class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

sumOnAdjustments(CurrencyUnit, Function<FulfillmentGroupAdjustment, MonetaryAmount>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Sums some attribute of the adjustments of this fulfillment group.

sumOnAdjustments(CurrencyUnit, Function<FulfillmentGroupAdjustment, MonetaryAmount>, Predicate<FulfillmentGroupAdjustment>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Sums some attribute of the adjustments of this fulfillment group.

sumOnItems(CurrencyUnit, Function<EnhancedFulfillmentLineItem, MonetaryAmount>) - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

Sums some attribute of the items of this fulfillment group.

supports(Class<?>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.validation.MarketingMessageValidator

supports(Class<?>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

supports(Class<?>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.context.validation.OrderValidator

T

TARGET - com.broadleafcommerce.promotion.offer.domain.type.ItemRestrictionType

Target Item or Item Qualifier can be used as a target by other offers but not as a qualifier.

TARGET_AND_QUALIFIER - com.broadleafcommerce.promotion.offer.domain.type.ProrationType

The discount for an offer is spread across targeted and qualifying items.

TARGET_ONLY - com.broadleafcommerce.promotion.offer.domain.type.ProrationType

The discount is only applied to the targeted items of the offer.

TargetGroupingStrategy - Enum in com.broadleafcommerce.promotion.offer.domain.type

TargetLineItemOfferDetailComparator - Class in com.broadleafcommerce.promotion.offer.service.dto.comparator

Comparator for LineItemOfferDetails being used as targets of offers.

TargetLineItemOfferDetailComparator() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

TargetLineItemOfferDetailComparator(boolean, String) - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

targetQtyRequired(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

TARGETS - com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageTargetType

Indicates that an offer's marketing message should be displayed with items targeted by the offer.

TENANT_ID_PATH - Static variable in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener

TIERED_CART_SUBTOTAL - com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

Determines whether an offer uses tiered discounts such that the discount changes depending on cart subtotal amount.

TIERED_ITEM_QTY - com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

Determines whether an offer uses quantity based tiered discounts such that the discount changes depending on how many items are in a cart.

TIERED_ITEM_SUBTOTAL - com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

Determines whether an offer uses tiered discounts such that the discount changes depending on item subtotal amount.

toMe() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

toMe() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

toMe() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

toString() - Method in class com.broadleafcommerce.promotion.offer.cache.OfferCacheProperties

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.Attribute

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.CombinabilityOverride

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.Discount

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.DiscountTier

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteria

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemCriteriaRule

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.ItemMarketingMessageRequest

Deprecated.

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessage

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessageResponse

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.MarketingMessages

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.Offer

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.OfferAuditDetail

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.SharedCode

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.SubscriptionDiscount

toString() - Method in class com.broadleafcommerce.promotion.offer.domain.UserTarget

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaAttribute

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCampaignTracking

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaCombinabilityOverride

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaDiscountTier

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaItemCriteriaRule

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaMarketingMessage

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOfferAuditDetail

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaSharedCode

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaUserTarget

toString() - Method in class com.broadleafcommerce.promotion.offer.provider.jpa.environment.OfferProperties

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroup

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateFulfillmentGroupOffer

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateItemOffer

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOffers

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.QualifierLineItemOfferDetailComparator

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.comparator.TargetLineItemOfferDetailComparator

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.DiscountParameters

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.FulfillmentGroupOfferPermutationResult

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferCombinabilityCriteria

toString() - Method in class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

toString() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.Adjustment

toString() - Method in class com.broadleafcommerce.promotion.offer.service.messaging.checkout.RecordOfferUsageEventListener.OfferRef

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.CustomerFields

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentGroup

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedFulfillmentLineItem

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrder

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.EnhancedOrderLineItem

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedItemOfferAdjustment

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.EnhancedProratedOfferAdjustment

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.FulfillmentGroupAdjustment

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.ItemOfferAdjustment

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.LineItemOfferDetail

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferDiscount

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OfferQualifier

toString() - Method in class com.broadleafcommerce.promotion.offer.web.context.info.OrderOfferAdjustment

toStringWithoutOrder() - Method in class com.broadleafcommerce.promotion.offer.service.dto.CandidateOrderOffer

Alternate implementation of toString that does not include the CandidateOrderOffer.order to be used by OrderOfferAdjustment in order to avoid infinite loop just from that context.

totalAdjustmentValue() - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

TotalPotentialSavings - Class in com.broadleafcommerce.promotion.offer.service.dto

DTO containing the total potential savings info for all of an order's order items due to the application of a single CandidateItemOffer.

TotalPotentialSavings() - Constructor for class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

trackingValuesToTrackingEntities() - Static method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

truncateCandidateGroups(CandidateFulfillmentGroupOffer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

typeFactory - Variable in class com.broadleafcommerce.promotion.offer.service.DefaultMarketingMessageResolver

typeFactory - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.ItemMarketingMessageRetrievalEndpoint

Deprecated.

typeFactory - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

U

updateBestCombinedTypesPermutation() - Method in class com.broadleafcommerce.promotion.offer.service.dto.OfferProcessingContext

updateBestFulfillmentGroupPermutation(FulfillmentGroupOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

updateBestFulfillmentItemPermutation(ItemOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

updateBestOrderItemPermutation(ItemOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

updateBestOrderOfferPermutation(OrderOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.dto.CombinedTypesOfferPermutation

updateBestPermutation(CombinedTypesOfferPermutation, ItemOfferPermutationResult) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultItemOfferProcessor

updateFulfillmentGroupTotal(EnhancedOrder) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.DefaultFulfillmentGroupOfferProcessor

updateFulfillmentGroupTotal(EnhancedOrder) - Method in interface com.broadleafcommerce.promotion.offer.service.engine.application.processor.FulfillmentGroupOfferProcessor

updateMessage(String, String, MarketingMessage, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.MarketingMessagesEndpoint

updateOffer(HttpServletRequest, ContextInfo, String, Offer) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OffersEndpoint

updateOfferAuditDetail(HttpServletRequest, ContextInfo, String, OfferAuditDetail) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferAuditDetailsEndpoint

updateOfferCombinabilityCriteria(CandidateOffers) - Method in class com.broadleafcommerce.promotion.offer.service.dto.BaseCandidateOffer

updateProratedAdjustmentsWithRoundedAdjustments(Collection<D>, Map<String, MonetaryAmount>, CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.MoneyRoundingHelper

Sets the new rounded adjustment values on the given EnhancedProratedOfferAdjustments

updateTotalAdjustmentsValue(List<LineItemOfferDetail>) - Method in class com.broadleafcommerce.promotion.offer.service.dto.ItemOfferPermutationResult

usePercentOffValue(Offer) - Method in class com.broadleafcommerce.promotion.offer.service.engine.application.processor.helper.item.DefaultPotentialSavingsCalculator

UserMaxUsesStrategyType - Enum in com.broadleafcommerce.promotion.offer.domain.type

Determines how the Offer.maxUsesPerUserStrategy will be applied.

UserTarget - Class in com.broadleafcommerce.promotion.offer.domain

Abstraction of a user that offers can target.

UserTarget() - Constructor for class com.broadleafcommerce.promotion.offer.domain.UserTarget

UserTarget(String, String) - Constructor for class com.broadleafcommerce.promotion.offer.domain.UserTarget

UserTarget(String, String, EmbeddedContextState) - Constructor for class com.broadleafcommerce.promotion.offer.domain.UserTarget

userTargetValuesToUserTargetEntities() - Static method in class com.broadleafcommerce.promotion.offer.provider.jpa.domain.JpaOffer

V

validate(Object, Errors, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.validation.MarketingMessageValidator

validate(Object, Errors, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validate(Object, Errors, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.context.validation.OrderValidator

validateActiveEndDate(MarketingMessage, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.MarketingMessageValidator

validateActiveEndDate(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateActiveStartDate(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateCheapestTargetGroupingStrategyOnlyOrderItemTargetType(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateCombinabilityType(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateDiscount(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateDiscountTier(Offer, DiscountTier, Errors, String) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateDiscountTiers(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateFreeGiftOffer(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateItemCriteria(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateLocationType(Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.MarketingMessageValidator

validateMaxUsesPerUserStrategy(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateName(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateNotFixedPrice(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateOfferCodeUsages(List<String>, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferCodeUsageValidator

validateOfferCodeUsages(List<String>, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.validation.OfferCodeUsageValidator

With a provided list of offer codes, determine which codes are no longer usable in a given context.

validateOfferUsage(HttpServletRequest, ContextInfo, CustomerContext, List<String>, List<String>) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

validateOfferUsages(List<String>, CustomerContext, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultOfferUsageValidator

validateOfferUsages(List<String>, CustomerContext, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.validation.OfferUsageValidator

With the provided offer ids and CustomerContext, determine which offers are no longer usable in a given context.

validateOrderNumber(Errors) - Method in class com.broadleafcommerce.promotion.offer.web.context.validation.OrderValidator

validateSubscriptionDiscount(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateTargetType(Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.MarketingMessageValidator

validateText(Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.MarketingMessageValidator

validateUserTargets(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateVoucherOffer(Offer, Errors) - Method in class com.broadleafcommerce.promotion.offer.service.validation.OfferValidator

validateVoucherOfferUsages(EnhancedOrder, boolean, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.service.validation.DefaultVoucherOfferUsageValidator

validateVoucherOfferUsages(EnhancedOrder, boolean, ContextInfo) - Method in interface com.broadleafcommerce.promotion.offer.service.validation.VoucherOfferUsageValidator

With the provided order, determine which voucher offers are no longer usable in a given context.

validateVouchers(HttpServletRequest, EnhancedOrder, boolean, ContextInfo) - Method in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.CombinabilityOverrideType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.CombinabilityType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountMethodType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountTimingType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.ItemRestrictionType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageTargetType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.ProrationType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.TargetGroupingStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.UserMaxUsesStrategyType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.broadleafcommerce.promotion.offer.service.dto.type.LineItemType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.OfferDiscountStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.CombinabilityOverrideType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.CombinabilityType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountMethodType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.DiscountTimingType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.ItemRestrictionType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageTargetType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.ProrationType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.TargetGroupingStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.domain.type.UserMaxUsesStrategyType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.broadleafcommerce.promotion.offer.service.dto.type.LineItemType

Returns an array containing the constants of this enum type, in the order they are declared.

VOUCHER - com.broadleafcommerce.promotion.offer.domain.type.DiscountTargetType

The offer's discount results in a VOUCHER that can be applied to a future offer

voucherOfferUsageValidator - Variable in class com.broadleafcommerce.promotion.offer.web.endpoint.OfferEngineEndpoint

VoucherOfferUsageValidator - Interface in com.broadleafcommerce.promotion.offer.service.validation

Validator used to run checks against voucher offers to determine which offers are still usable.

W

withAmount(MonetaryAmount) - Method in class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

withWeightedSavingsPercentage(BigDecimal) - Method in class com.broadleafcommerce.promotion.offer.service.dto.TotalPotentialSavings

Z

zeroIfNull(MonetaryAmount, CurrencyUnit) - Method in class com.broadleafcommerce.promotion.offer.service.engine.proration.DefaultProrationService

Defaults the amount to zero if null.

A B C D E F G H I J L M N O P Q R S T U V W Z
All Classes All Packages