All Classes and Interfaces
Class
Description
Common functionality between checking availability between adds and updates
Only the product is required to add an item to an order.
Implementors of the SolrIndexServiceExtensionHandler interface should extend this class so that if
additional extension points are added which they don't care about, their code will not need to be
modified.
Component to provide basic functionality around handling SolrUpdateCommands.
This component is an abstract component that will be extended by more concrete implementations for updating
or reindexing Solr.
Implementors of the SolrSearchServiceExtensionHandler interface should extend this class so that if
additional extension points are added which they don't care about, their code will not need to be
modified.
Interface to be used for workflows in Broadleaf.
ActivityMessageDTO will hold messages that will be passed between activities/workflows.
Manages activity state for the current thread during workflow execution.
Deprecated.
As of Broadleaf version 3.1.0, saves of individual aspects of an Order (such as OrderItems and FulfillmentGroupItems) no
longer happen in their respective activities.
The AdjustOrderPaymentsActivity is responsible for adjusting any of the order payments
that have already been applied to the order.
Add advanced offer support to an Offer
DTO used to carry back the found
ProductOptionValue.getId() and
ProductOption.getAttributeName() on a given
ProductThis pricing workflow step will automatically bundle items in the cart.
Deprecated.
This is no longer required and is instead implemented as a third-party inventory module
Used in conjunction with
BandedPriceFulfillmentOption and BandedWeightFulfillmentOption.Entity associated with sensitive, secured bank account data.
Base class for all Workflow Processors.
Convenience methods for interacting with
PromotionMessagesDeprecated.
instead, see the ProductType Module's Product Add-On's usage of
DiscreteOrderItemsDeprecated.
OrderItem level offer that has been qualified for an order,
but may still be ejected based on additional pricing
and stackability concerns once the order has been processed
through the promotion engine.
Provides a method that creates the seed ProcessContext object for a cart
operation.
This class represents the basic context necessary for the execution
of a particular order process workflow operation.
Marker interface.
Marker interface.
Default command handler to handle Catalog Solr index commands.
Command service for issuing (queuing) Catalog (re)index commands.
Lightweight bean representation of
This service provides some URL manipulation capabilities.
Implementations of this interface are used to hold data about a Category.
Created by brandon on 8/28/15.
CategoryDao provides persistence access to Category instances.Implementations of this interface are used to hold data about the many-to-many relationship between
the Category table and the Product table.
The Class CategoryProductXrefImpl is the default implmentation of
Category.Responsible for generating site map entries for Category.
CategorySiteMapGenerator is controlled by this configuration.
CategorySiteMapGenerator is controlled by this configuration.
Implementations of this interface are used to hold data about the many-to-many relationship between
the Category table and a parent Category.
CategoryXrefDao provides persistence access to the relationship
between a category and its sub-categories.This activity handles both adds and updates.
Very similar to the
CheckAddAvailabilityActivity but in the blUpdateItemWorkflow insteadDeprecated.
Deprecated.
Deprecated.
Deprecated.
This is an optional activity to allow a committal of taxes to a tax sub system.
Rollback handler to execute after an order has been marked as 'completed' and there is an exception.
Rolls back all payments that have been processed or were confirmed in
ValidateAndConfirmPaymentActivity.Provides the same methods from
InventoryService but with optional, additional context information.This class is used in conjunction with the
DetermineOfferChangeActivity to determine if the number
of offers changed on the order during the pricing workflow.Entity associated with sensitive, secured credit card data.
This is a specific interface for CrossSaleProductImpl and is needed for entity mapping and translations
Determines how the Offer.getMaxUsesPerCustomer() will be applied.
Deprecated.
Decrements inventory
Decrements inventory that was put on by the
DecrementInventoryActivityCore framework implementation of the
CustomerPaymentGatewayService.Default implementation of the
DynamicSkuPricingService which simply ignores the considerations hashmap in all
method implementationsDefault implementation of OfferCodeDaoExtensionHandler.
Core framework implementation of the
PaymentGatewayCheckoutService.Default ProcessContext implementation
Wrapper implementation of Solr that delegates to an
HttpSolrClient.The idea of this class if to iterate over props of the passed class and if found prop with annotation @OneToMany
recurse into it.
This class is used in conjunction with the
CountTotalOffersActivity to determine if the number
of offers changed on the order during the pricing workflow.Interface that defines a distributed
BlockingQueue, which means that this queue can be created, distributed, and operated on by multipleRuntimeException indicating that there was an error operating on the queue, or changing queue state.Interface to define a lock as distributed and safe to use across nodes or JVMs.
RuntimeException to identify that there was an issue obtaining or otherwise releasing a distributed lock.
Component to build a Solr document from an
Indexable.Interface for dynamically determining the activity dates.
DTO to represent pricing overrides returned from invocations to
DynamicSkuPricingServiceInterface for calculating dynamic pricing for a
Sku.Convenience class for creating an empty workflow.
Utility class that will search for the entity identifier property and/or property value
Represents a String-based mapping of entities and properties.
DAO to facilitate interaction with Broadleaf fields.
An extensible enumeration of entities that are used for searching and reporting
An extensible enumeration of entities that are used for searching and reporting
XML based Index Status provider.
Used in conjunction with the
FixedPriceFulfillmentPricingProvider to allow for a single price
for fulfilling an order (e.g. $5 shipping)Processor used in conjunction with
FixedPriceFulfillmentOption.This entity is a collection of properties shared between different band implementations.
DTO to allow FulfillmentProcessors to respond to estimation requests for a particular FulfillmentGroup
for a particular FulfillmentOptions
This is the main entity used to hold fulfillment information about an Order.
The methods in this class are invoked by the add and update item to cart workflows.
Called during the pricing workflow to set the merchandise total for each FulfillmentGroup
in an Order.
Called during the pricing workflow to compute all of the fulfillment costs
for all of the FulfillmentGroups on an Order and updates Order with the
total price of all of the FufillmentGroups
An extendible enumeration of fulfillment group status types.
Called during the pricing workflow to set each item's merchandise total and taxable total
This can be used by various third-party fulfillment pricing services in order to
resolve a location that items will be shipped from in order to properly calculate the
cost of fulfilling that particular fulfillment group.
A FulfillmentOption is used to hold information about a particular type of Fulfillment implementation.
This entity defines the bands that can be specified for
BandedPriceFulfillmentOption.Main extension interface to allow third-party integrations to respond to fulfillment pricing
This service can be used in a couple of different ways.
An extendible enumeration of fulfillment group types.
This entity defines the bands that can be specified for
BandedWeightFulfillmentOption.Entity associated with sensitive, secured bank account data.
Rebuilds the entire Solr index.
If the field is translatable, then this method prefixes the field with supported locales.
If the field is translatable, then this method prefixes the field with supported locales.
Mainly a marker interface denoting that the entity should be indexed for search
Represents a field that gets stored in the search index
DAO used to interact with the database search fields
This interface is used for representing a
FieldType for an IndexFieldGeneral information about the current status of a (embedded) Solr instance's index
This basic inventory service checks and adjusts the current inventory of a sku.
Marker interface to dictate the overridden methods within
ContextualInventoryService.Enumeration to specify whether inventory should be checked or not.
This interface is used as a part of a template pattern in ItemOfferProcessor that allows reuse to other BLC modules.
Filter and apply order item offers.
The same as
ItemOfferComparator but uses the PromotableCandidateItemOffer.getPotentialSavingsQtyOne()
method instead.This interface represents an Offer instance that has some additional, deprecated fields related to uses and maxUses
Holds the backwards compatibility field for uses.
Extension handler for merge cart
Extension manager for merge cart.
The 2.0 implementation of merge cart service.
An extendible enumeration of type of messages.
This interface can be used with an Offer implementation to indicate that an offer supports minimum required targets.
Marker interface that all modules should use when adding activities to Broadleaf workflows.
Convenience methods for converting simple MVEL rules to Solr SearchCriteria
Convenience methods for converting simple MVEL rules to Solr SearchCriteria
This event listener is responsible for sending any notifications in response to an
OrderSubmittedEvent.This class provides the implementation of a strategy that does not touch
FulfillmentGroupItems when cart add or update operations have been performed.
Generates a shared, static instance of NullOrderImpl.
NullOrderImpl is a class that represents an unmodifiable, empty order.
This indicates how an Offer should be fulfilled to the customer, defaulting to order time discount.
Captures when an offer was applied to a customer.
DAO for auditing what went on with offers being added to an order
Service for managing
OfferAudits.An extendible enumeration of discount types.
Modify new Offer duplicates before persistence
An extendible enumeration of offer item restriction types.
Represents tokens for optional fields to be weaved into OfferImpl
An extendible enumeration of offer types.
An extendible enumeration of offer rule types.
The Interface OfferService.
The Class OfferServiceImpl.
This class serves to allow reuse of logic between the core offer service and related offer service extensions.
Represents a tier and amount combination for an offer.
An extendible enumeration of offer types.
An extendible enumeration of offer types.
Allows convert offer values for offers with OfferDiscountType.AMOUNT_OFF
and OfferDiscountType.FIX_PRICE types based on the used PriceList
Deprecated.
Deprecated.
Defines an order in Broadleaf.
The Interface OrderAttribute.
The Class OrderAttributeImpl
The Interface OrderItemAttribute.
Arbitrary attributes to add to an order-item.
Class that contains a reference to an OrderItem
Records the actual adjustments that were made to an OrderItemPriceDetail.
Only the product and quantity are required to add an item to an order.
An extendible enumeration of order item types.
Domain object used to synchronize
Order operations.It is recommended to only allow one write operation on orders at a time.
Represents a given set of options for an OrderItem in an Order in the
multiship context.
Provides support for reading OrderMultishipOptions.
This DTO is used to bind multiship options in a way that doesn't require
the actual objects to be instantiated -- we handle that at the controller
level.
Service to interact with OrderMultishipOptions
This entity is designed to deal with payments associated to an
Order and is usually unique for a particular
amount, PaymentGatewayType and PaymentType combination.Implementation to "confirm" an unconfirmed transaction.
Strategy to handle confirming "UNCONFIRMED" transactions on an Order Payment during the checkout workflow.
Used to determine the status of an
OrderPayment
which is calculated based on the state of its containing
PaymentTransactionsThis service provides a mechanism to calculate order payment status which
is dynamically calculated based on the state of the containing transactions.
The main function of this entity listener is to publish a Spring event that the customer has been persisted.
An event for whenever an
OrderImpl has been persistedThe general interface for interacting with shopping carts and completed Orders.
An extendible enumeration of order status types.
Service that translates various pieces of information such as:
-
Order
- PaymentTransaction
into a PaymentRequestDTO so that the gateway can create
the appropriate request for a specific transaction.Created by bpolster.
Container object for the results from a lightweight query that retrieves parent categories
for a child category
Container object for the results of a lightweight query that retrieves the parent category
for a child product
A Do-nothing activity used to test proper merge ordering in workflows
A Default Configuration to handle Passthrough Payments, for example COD payments.
A Default Configuration to handle Passthrough Payments, for example COD payments.
This default implementation will create a compensating transaction response based on the transaction type passed in
for any Passthrough Order Payments on the order.
Used to store individual transactions about a particular payment.
Implementations of this interface are used to hold data for a Product.
The Interface ProductAttribute.
The Class ProductAttributeImpl.
Deprecated.
instead, use the ProductType Module's Product Add-Ons to build and configure bundles
Created by bpolster.
Deprecated.
instead, use the ProductType Module's Product Add-Ons to build and configure bundles
ProductDao provides persistence access to Product instancesThe Class ProductImpl is the default implementation of
Product.A product option represents a value that is entered to specify more information about
a product prior to entering into the cart.
An extendible enumeration of product option types.
An extendible enumeration of product option validation strategy types.
An extendible enumeration of product option validation types.
Stores the values for a given product option.
Container object for the results of a lightweight query that retrieves the product ids
for a category along with their display order.
Responsible for generating site map entries for Product.
An extendible enumeration of product types.
This class holds adjustment records during the discount calculation
processing.
This class holds adjustment records during the discount calculation
processing.
Modules that extend offer engine behavior can benefit from a wrapped PromotableOrderItemPriceDetail.
Records the usage of this item as qualifier or target of
the promotion.
A Generic DTO object that represents the information to display a
PromotionMessage.A
PromotionMessageGenerator understands how to gather applicable PromotionMessages
for the given Product or OrderItem.An extendible enumeration of promotion message location types.
An extendible enumeration of promotion message types.
Records the usage of this item as qualifier or target of
the promotion.
Wraps the promotion qualifier.
Interface to centralize the promotion rounding functionality found in several of the Promotable classes.
Saves an instance of OfferAudit for each offer in the passed in order.
Rolls back audits that were saved in the database from
RecordOfferUsageActivity.This is similar to a
ReentrantLock, except that it uses Zookeeper to
share the lock state across multiple nodes, allowing for a distributed lock.The main interface used to store extra-secure data such as credit card, bank accounts and gift card data.
Holder to contain cross-thread state during Solr reindexing.
Interface for finding related products.
Extensible enumeration indicating types of product relations such as upsell, crosssell, or featured.
This class is responsible for determining which OrderItems should be removed from the order, taking into account
the fact that removing an OrderItem should also remove all of its child order items.
This runtime exception will be thrown when an attempt to add to cart without specifying
all required product options has been made.
Adds capability to delete old or defunct entities from the persistence layer (e.g.
Service capable of deleting old or defunct entities from the persistence layer (e.g.
Service capable of deleting old or defunct entities from the persistence layer (e.g.
This exception is thrown to indicate a problem while trying to rollback
state for any and all activities during a failed workflow.
Implementations are responsible for performing compensating operations to revert the state of the activity to what it
was prior to execution.
Handles the identification of the outermost workflow and the current thread so that the StateManager can
operate on the appropriate RollbackHandlers.
Provide confiration information about arbitrary field data used to drive rule builders in the admin.
This contains a map of objects representing the context dtos for a search.
Container that holds additional criteria to consider when performing searches for Products
A SearchFacet is an object that represents a particular facet that can be used to guide faceted
searching on a results page.
DAO used to interact with the database search facets
Deprecated.
Replaced in functionality by
SearchRedirectDeprecated.
Replaced in functionality by
SearchRedirectDaoDeprecated.
Replaced in functionality by
SearchRedirectDaoImplDeprecated.
Replaced in functionality by
SearchRedirectImplCreated by ppatel.
Created by ppatel.
Created by bpolster.
Created by ppatel.
Container that holds the result of a ProductSearch or a SkuSearch
Acquisition of Primary Account Number (PAN) and other sensitive information
is retrieved through a service separate from the order.
Default implementation of
FulfillmentLocationResolver that stores a
single Address.
Simple factor-based tax module that can be configured by adding rates for
specific postalCodes, city, state, or country.
Implementations of this interface are used to hold data about a SKU.
Interface indicating that an item contains a getSku method.
Convenient place to store the active date context and the related service on thread local.
Implementations of this interface are used to hold data about a SKU's Attributes.
The Class SkuAttributeImpl is the default implementation of
SkuAttribute.Deprecated.
This is no longer required and is instead implemented as a third-party inventory module
Deprecated.
This is no longer required and is instead implemented as a third-party inventory
module
Deprecated.
instead, use the ProductType Module's Product Add-Ons to build and configure bundles
Deprecated.
instead, use the ProductType Module's Product Add-Ons to build and configure bundles
SkuDao provides persistence access to Sku instancesUsed to represent Sku-specific surcharges when fulfilling this item.
The Class SkuImpl is the default implementation of
Sku.SkuMediaDao provides persistence access to SkuMediaXref instancesConvenient place to store the pricing considerations context and the pricing service on thread local.
Join entity between
Sku and ProductOptionValue.Responsible for generating site map entries for Sku.
Provides a class that will statically hold the Solr server.
Provides utility methods that are used by other Solr service classes
Provides a single cache while exposing a block of code for execution to
SolrIndexService.performCachedOperation(org.broadleafcommerce.core.search.service.solr.SolrIndexCachedOperation.CacheOperation).Basic interface representing a block of work to perform with a single cache instance
Provides some specialized catalog retrieval methods for
SolrIndexService for maximum
efficiency of solr document creation during indexing.Defines the lifecylce of an indexing operation used in
SolrIndexService.Provides a FIFO
Queue to hold a series of commands to be executed in sequence.Service exposing several methods for creating a Solr index based on catalog product data.
Extension handler for indexing operations in Solr.
Manages extension points for SolrSearchService
Responsible for building and rebuilding the Solr index
Responsible for reading and writing the index status to some persistent store (e.g. the file system).
Responsible for reading and writing the status using one or more
SolrIndexStatusProvider
instances.Implementations of this interface do the heavy lifting with respect to executing the provided commands.
This is the entry point for issuing commands to update Solr indexes / collections.
Manages extension points for SolrSearchService
An implementation of SearchService that uses Solr.
An extendible enumeration of offer types.
Created by bpolster.
Utilized within the blPricingWorkflow to calculate tax for an
OrderThe Interface TaxDetail.
Generic service to calculate taxes.
An extensible enumeration of tax detail types
Simple workflow activity to simulate an amount of latency introduced by communicating
with a third party provider (e.g. credit card processing).
The TotalActivity is responsible for calculating and setting totals for a given order.
This is a specific interface for CrossSaleProductImpl and is needed for entity mapping and translations
This class creates the following BLC domain object for the Spring Social User Connection.
This activity is responsible for validating and processing several aspects of an order's payment so that
it may successfully complete the checkout workflow.
This will check the availability and quantities (if applicable) all order items in checkout request.
This activity is responsible for providing an extension point for validating a checkout request.
This is an required activity to valiate if required product options are in the order.
Checks the offers being used in the order to make sure that the customer
has not exceeded the max uses for the
Offer.Provide a template class that holds interfaces, fields and methods to be optionally, dynamically introduced
into OfferImpl at runtime.
Represents a
Queue that is distributed (used by multiple JVMs or nodes) and managed by Zookeeper.Simple utility to assist in basic operations related to Zookeeper.