All Classes

Class	Description
Attribute	Many entities have customizable dynamic attributes, and this class is intended to hold such values.
AttributeMapConverter	Transforms a Map of String keys and JpaAttribute values into a JSON object String and vice versa.
BadOrderDataException
BaseCandidateOffer
CandidateFulfillmentGroup	Represents a candidate fulfillment group for which an Offer has been applied.
CandidateFulfillmentGroupOffer	DTO containing information necessary for determining if an Offer that can apply to one or more EnhancedFulfillmentGroups is part of the best permutation of all offers applicable to that group.
CandidateItemOffer	DTO containing information necessary for determining if an Offer that can apply to an EnhancedLineItem is part of the best permutation of all offers applicable to that line item.
CandidateItemOfferComparator
CandidateOffers	DTO containing the candidate offers broken out into groups based on an offer's Discount.getTargetType() }.
CandidateOfferUtility	Utility for creating each of the different CandidateXOffer types: CandidateOrderOffer, CandidateItemOffer, CandidateFulfillmentGroupOffer.
CandidateOrderOffer	DTO containing information necessary for determining if an Offer that can apply to an EnhancedOrder is part of the best permutation of all offers applicable to that order.
CombinabilityOverride	Represents a collection of overrides to other combinability and stacking settings.
CombinabilityOverrideType	Enumerates the combinability override options for an CombinabilityOverride.
CombinabilityType	Enumerates the combinability options for an Offer.
CombinedTypesOfferPermutation	DTO containing a permutation for each offer type
CompatibleOfferNode	This class is used by the OfferProcessingContext to build a tree of compatible offers of the same type.
CompatiblePermutationNode	This class is used by the OfferProcessingContext to build a tree of compatible permutations.
CustomerFields	Configuration properties for defining the names of the customer fields that can be targeted by UserTarget.targetTypes.
CustomizedMarketingMessageRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable>	Adds customized methods for dealing with MarketingMessage persistence.
CustomizedOfferAuditDetailRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable>
CustomizedOfferRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable>	Advanced functionality related to offer maintenance and filtering.
DefaultCandidateOfferUtility
DefaultFulfillmentGroupOfferProcessor
DefaultItemMarketingMessageResolver<P extends MarketingMessage,O extends Offer>	Deprecated. since 1.6, use MarketingMessageResolver instead
DefaultItemOfferProcessor
DefaultMarketingMessageOfferCandidateService<P extends Offer>
DefaultMarketingMessageResolver<P extends MarketingMessage,O extends Offer>
DefaultMarketingMessageService<P extends MarketingMessage>
DefaultOfferApplicationService
DefaultOfferAuditDetailService<P extends OfferAuditDetail>
DefaultOfferCandidateService<P extends Offer>
DefaultOfferCodeUsageValidator
DefaultOfferEngineResponseBuilder<P extends EnhancedProratedItemOfferAdjustment>
DefaultOfferEngineService
DefaultOfferService<P extends Offer>
DefaultOfferUsageValidator
DefaultOfferUserService
DefaultOrderAndItemOfferHelper
DefaultOrderOfferProcessor
DefaultPotentialSavingsCalculator
DefaultProrationService
DefaultQualifierAndTargetMarker
DefaultVoucherOfferUsageValidator
Discount	Encapsulates all of the fields relevant to an offer's discount.
DiscountMethodType	Enumerates the methods whereby to apply an offer's discount to a target.
DiscountParameters	Parameters used in the DefaultOfferApplicationService to calculate the potential discount of a CandidateItemOffer for an EnhancedLineItem.
DiscountTargetType	Enumerates the kinds of entities to which an Discount.getAmount() mount offer's discount} can apply.
DiscountTier	Represents a tier and amount combination for an offer's discount.
DiscountTierListConverter	Converter used for converting a String List type to a JSON String before persistence.
DiscountTimingType	Enumerates the options for when an offer's discount is be applied.
EnhancedFulfillmentGroup
EnhancedFulfillmentLineItem
EnhancedLineItem
EnhancedOrder
EnhancedOrderLineItem
EnhancedProratedItemOfferAdjustment	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()).
EnhancedProratedOfferAdjustment
FulfillmentGroupAdjustment	DTO containing price adjustment information for an EnhancedFulfillmentGroup caused by a CandidateFulfillmentGroupOffer targeting it.
FulfillmentGroupOfferPermutationResult	DTO containing results of the evaluation of a permutation of item offers.
FulfillmentGroupOfferProcessor	A service for calculating, determining, and applying the best fulfillment offers.
ItemCriteria	Encapsulates all criteria used either to determine if an item is a qualifier or a target.
ItemCriteriaRule	Encapsulates a single rule the forms a part of an ItemCriteria.
ItemCriteriaSetConverter	Converter used for converting a String List type to a JSON String before persistence.
ItemMarketingMessageRequest	Deprecated. since 1.6, use MarketingMessageRequest instead.
ItemMarketingMessageResolver<P extends MarketingMessage,O extends Offer>	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	Deprecated. since 1.6, use MarketingMessageRetrievalEndpoint instead.
ItemOfferAdjustment	DTO containing price adjustment information for a EnhancedLineItem caused by a CandidateItemOffer targeting it.
ItemOfferPermutationResult	DTO containing results of the evaluation of a permutation of item offers.
ItemOfferProcessor	A service for calculating, determining, and applying the best order item offers.
ItemOfferQtyOneComparator	Compares CandidateItemOffers using Offer.priority then CandidateItemOffer.potentialSavingsQtyOne.
ItemOfferWeightedPercentSavedComparator	Compares CandidateItemOffers using Offer.priority then CandidateItemOffer.weightedPercentSaved.
ItemRestrictionType	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.
JpaAttribute	Persistent counter-part to an Attribute for use with a JPA datastore.
JpaCampaignTracking	Persistent counter-part to campaign tracking information for use with a Jpa datastore.
JpaCampaignTrackingId
JpaCombinabilityOverride	Persistent counter-part to a CombinabilityOverride for use with a Jpa datastore.
JpaCombinabilityOverrideId
JpaCustomizedMarketingMessageRepository<D extends JpaMarketingMessage>
JpaCustomizedOfferAuditDetailRepository<D extends JpaOfferAuditDetail>
JpaCustomizedOfferRepository<D extends JpaOffer>
JpaDiscountTier	Persistent counter-part to a DiscountTier for use with a Jpa datastore.
JpaItemCriteriaRule	Persistent counter-part to an ItemCriteriaRule for use with a Jpa datastore.
JpaMarketingMessage	Persistent counter-part to a MarketingMessage for use with a Jpa datastore.
JpaMarketingMessageRepository<D extends JpaMarketingMessage>
JpaOffer	Persistent counter-part to a Offer for use with a Jpa datastore.
JpaOfferAuditDetail	Persistent counter-part to OfferAuditDetail for use with a Jpa datastore.
JpaOfferAuditDetailRepository<D extends JpaOfferAuditDetail>
JpaOfferRepository<D extends JpaOffer>
JpaRouteConstants
JpaRouteConstants.Persistence
JpaSharedCode	Persistent counter-part to a SharedCode for use with a Jpa datastore.
JpaSharedCodeId
JpaUserTarget	Persistent counter-part to UserTarget for use with a Jpa datastore.
JpaUserTargetId
LineItemOfferDetail	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}.
LineItemType	Enumerates the kinds of LineItems that exist.
MarketingMessage	A MarketingMessage encapsulates information necessary for displaying a marketing message related to an Offer next to items affected by the offer in different contexts.
MarketingMessageLocationType	Enumeration that determines the locations in which an offer's marketing message should appear.
MarketingMessageOfferCandidateService<P extends Offer>	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>	Repository for persistent counter-parts of MarketingMessages.
MarketingMessageRequest	A DTO used to make requests to the MarketingMessageResolver, which finds MarketingMessages.
MarketingMessageResolver<P extends MarketingMessage,O extends Offer>	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>	A DTO to return a list of MarketingMessages.
MarketingMessageRetrievalEndpoint
MarketingMessages	A DTO to return a list of MarketingMessages.
MarketingMessagesEndpoint	MarketingMessage is a subresource of Offer, so most of these endpoints fall under the same base URL as OffersEndpoint.
MarketingMessageService<P extends MarketingMessage>	Base service API for MarketingMessage.
MarketingMessageTargetType	Enumerates the types of items a marketing message can target.
MarketingMessageValidator	Validations for MarketingMessage.
MoneyRoundingHelper	Helper class to calculate rounding of monetary unit amounts from offer adjustments.
Offer	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.
OfferApplicationService	This service adds adjustments to the order
OfferAuditDetail	Captures audit relevant data when an offer was applied to an order.
OfferAuditDetailRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable>
OfferAuditDetailsEndpoint
OfferAuditDetailService<P extends OfferAuditDetail>
OfferCacheAutoConfiguration	Configuration for engaging default Broadleaf support for Apache Ignite cache
OfferCacheProperties	Properties that influence cache settings for the pricing service
OfferCandidateService<P extends Offer>	This service determines what offers are candidates for a provided order and context.
OfferCheckoutCompletionConsumer	Spring cloud data channel description for messaging input.
OfferCodeUsageValidator	Validator used to run checks against offer codes to determine which codes are still usable.
OfferCombinabilityCriteria	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.
OfferCombinabilityCriteriaKey	A structure containing the combinability data for a single offer.
OfferDefaultsEnvironmentPostProcessor	Spring Boot default property overrides for this service
OfferDiscount	Additional info for all the offers treating an EnhancedLineItem as a target.
OfferDiscountStrategy
OfferEngineEndpoint
OfferEngineResponseBuilder<P extends com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedItemOfferAdjustment>	Tool to build a OrderResponse from the information provided via an EnhancedOrder.
OfferEngineService	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	Offer-specific configuration for validation.
OfferItemCriteriaRuleSetConverter	Transforms a Set to and from a JSON object string.
OfferJpaAutoConfiguration
OfferMessagingConfiguration
OfferMessagingProperties
OfferProcesingUtility	Utility methods used by the offer processing engine extracted for ease of testing.
OfferProcessingContext	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.
OfferProperties
OfferQualifier	DTO containing information about the order items used by an Offer as item qualifiers.
OfferRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable>
OffersEndpoint
OfferService<P extends Offer>
OfferServiceAutoConfiguration
OffersPermutation<T extends BaseCandidateOffer>	DTO containing a set of compatible offers of the same type and that share the same combinability with regard to other types.
OfferUsageValidator	Validator used to run checks against offers to determine which offers are still usable.
OfferUserService	Helper methods around users for offers.
OfferValidator	Validations for Offer.
OfferWebAutoConfiguration
OrderAndItemOfferHelper	This class contains methods with usage shared by ItemOfferProcessor and OrderOfferProcessor.
OrderOfferAdjustment	DTO containing price adjustment information for an EnhancedOrder caused by a CandidateOrderOffer targeting it.
OrderOfferPermutationResult	DTO containing results of the evaluation of a permutation of order offers.
OrderOfferProcessor	A service for calculating, determining, and applying the best order offers.
OrderTotals	DTO containing relevant totals such as the order subtotal, discountable subtotals, and other totals needed to determine the best offer.
OrderValidator
PotentialSavingsCalculator	This service is responsible for calculating the potential savings for Offer target items if that offer is was the only offer applied.
ProrationService	Calculates all of an Order's order and fulfillment LineItems' ProratedItemOfferAdjustments.
ProrationType	Enumeration to determine whether an offer's discount is divided amongst different types of order items: Whether just "targets" or also "qualifiers".
QualifierAndTargetMarker	This service is responsible for marking an order's order items as either targets or qualifiers for a given CandidateItemOffer.
QualifierLineItemOfferDetailComparator	Comparator for LineItemOfferDetails being used as qualifiers for offers.
RecordOfferUsageEventListener	An event listener that triggers when an order is successfully submitted.
RecordOfferUsageEventListener.Adjustment
RecordOfferUsageEventListener.OfferRef
RouteConstants
RouteConstants.Persistence
SharedCode	A simple structure that can be used to represent a code that applies an offer to an order.
SubscriptionDiscount	Encapsulates all of the fields relevant to an offer's subscription compatibility.
TargetGroupingStrategy
TargetLineItemOfferDetailComparator	Comparator for LineItemOfferDetails being used as targets of offers.
TotalPotentialSavings	DTO containing the total potential savings info for all of an order's order items due to the application of a single CandidateItemOffer.
UserMaxUsesStrategyType	Determines how the Offer.maxUsesPerUserStrategy will be applied.
UserTarget	Abstraction of a user that offers can target.
VoucherOfferUsageValidator	Validator used to run checks against voucher offers to determine which offers are still usable.