Uses of Class
com.broadleafcommerce.catalogbrowse.domain.Product

Packages that use Product

Package	Description
com.broadleafcommerce.catalogbrowse.domain
com.broadleafcommerce.catalogbrowse.service
com.broadleafcommerce.catalogbrowse.service.provider
com.broadleafcommerce.catalogbrowse.service.provider.external.catalog
com.broadleafcommerce.catalogbrowse.service.provider.external.inventory
com.broadleafcommerce.catalogbrowse.service.provider.external.pricing
com.broadleafcommerce.catalogbrowse.service.provider.external.pricing.product
com.broadleafcommerce.catalogbrowse.service.provider.external.search
com.broadleafcommerce.catalogbrowse.web.endpoint

Uses of Product in com.broadleafcommerce.catalogbrowse.domain

Methods in com.broadleafcommerce.catalogbrowse.domain that return Product

Modifier and Type	Method	Description
Product	ItemChoice.getDefaultProduct()	The default product that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS.
Product	ItemChoice.getDefaultProductInCategory()	The default product that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.CATEGORY.
Product	IncludedProduct.getProduct()	This field contains the specified product if the type is DefaultIncludedProductType.PRODUCT.
Product	SpecificItemChoice.getProduct()	If the SpecificItemChoice.type is DefaultSpecificItemChoiceType.PRODUCT this holds the product for this choice
Product	PromotionalCategoryProduct.getPromotionalProduct()	The product to promote.
Product	PromotionalProduct.getRelatedProduct()	The product being promoted.

Methods in com.broadleafcommerce.catalogbrowse.domain that return types with arguments of type Product

Modifier and Type	Method	Description
List<Product>	BrowseEntityDetails.getProducts()	All Products and their details if products match the BrowseDetailsRequest.
SimplePage<Product>	Category.getProducts()	A page of Products belonging to the category.
SimplePage<Product>	ItemChoiceCategory.getProducts()	A SimplePage of Products for the category to choose from.
List<Product>	ProductList.getProducts()	All Products and their details.
SearchResponse<Product>	Category.getSearchResponse()	If CategoryDetailsRequest.isHydrateCategoryProductsFromSearch() or BrowseDetailsRequest.isHydrateCategoryProductsFromSearch() is true, then this will be populated instead of Category.products.

Methods in com.broadleafcommerce.catalogbrowse.domain with parameters of type Product

Modifier and Type	Method	Description
void	ItemChoice.setDefaultProduct(Product defaultProduct)	The default product that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS.
void	ItemChoice.setDefaultProductInCategory(Product defaultProductInCategory)	The default product that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.CATEGORY.
void	IncludedProduct.setProduct(Product product)	This field contains the specified product if the type is DefaultIncludedProductType.PRODUCT.
void	SpecificItemChoice.setProduct(Product product)	If the SpecificItemChoice.type is DefaultSpecificItemChoiceType.PRODUCT this holds the product for this choice
void	PromotionalCategoryProduct.setPromotionalProduct(Product promotionalProduct)	The product to promote.
void	PromotionalProduct.setRelatedProduct(Product relatedProduct)	The product being promoted.

Method parameters in com.broadleafcommerce.catalogbrowse.domain with type arguments of type Product

Modifier and Type	Method	Description
void	BrowseEntityDetails.setProducts(List<Product> products)	All Products and their details if products match the BrowseDetailsRequest.
void	Category.setProducts(SimplePage<Product> products)	A page of Products belonging to the category.
void	ItemChoiceCategory.setProducts(SimplePage<Product> products)	A SimplePage of Products for the category to choose from.
void	ProductList.setProducts(List<Product> products)	All Products and their details.
void	Category.setSearchResponse(SearchResponse<Product> searchResponse)	If CategoryDetailsRequest.isHydrateCategoryProductsFromSearch() or BrowseDetailsRequest.isHydrateCategoryProductsFromSearch() is true, then this will be populated instead of Category.products.

Constructor parameters in com.broadleafcommerce.catalogbrowse.domain with type arguments of type Product

Modifier	Constructor	Description
	ProductList(List<Product> products, Set<String> productIdsForMissingEntities, Set<String> productUrisForMissingEntities)

Uses of Product in com.broadleafcommerce.catalogbrowse.service

Methods in com.broadleafcommerce.catalogbrowse.service that return types with arguments of type Product

Modifier and Type	Method	Description
protected CatalogSearchProvider<Product>	DefaultBrowseEntityResolver.getBrowseCatalogSearchProvider()

Methods in com.broadleafcommerce.catalogbrowse.service with parameters of type Product

Modifier and Type	Method	Description
protected LineItemDTO	DefaultMarketingMessageUtils.buildLineItemFromVariant(Product product, Variant variant)

Method parameters in com.broadleafcommerce.catalogbrowse.service with type arguments of type Product

Modifier and Type	Method	Description
void	DefaultBrowseEntityResolver.setBrowseCatalogSearchProvider(CatalogSearchProvider<Product> browseCatalogSearchProvider)

Uses of Product in com.broadleafcommerce.catalogbrowse.service.provider

Classes in com.broadleafcommerce.catalogbrowse.service.provider with type parameters of type Product

Modifier and Type	Interface	Description
interface	CatalogSearchProvider<T extends Product>	Provider for interfacing with operations around catalog search.

Methods in com.broadleafcommerce.catalogbrowse.service.provider with type parameters of type Product

Modifier and Type	Method	Description
<P extends Product> Collection<P>	InventoryProvider.determineProductsInventoryAvailability(Collection<P> products, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hydrates the SkuInventoryAvailabilitySummary for the provided Products and its Variants.
<T extends Product> void	CatalogProvider.hydrateProductAssets(Collection<T> products, org.springframework.util.MultiValueMap<String,String> parameters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the Assets for the provided products and populates them onto setAssets(java.util.List<com.broadleafcommerce.catalogbrowse.domain.Asset>).
<T extends Product> void	CatalogProvider.hydrateProductTags(Collection<T> products, org.springframework.util.MultiValueMap<String,String> parameters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the ProductTags for the provided products and populates them onto getAdvancedTags().
<P extends Product> List<P>	PricingProvider.priceProducts(Collection<P> products, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates pricing info for the provided Products and their related priceable entities: Variant, IncludedProduct, SpecificItemChoice.

Methods in com.broadleafcommerce.catalogbrowse.service.provider that return Product

Modifier and Type	Method	Description
Product	PricingProvider.priceProduct(Product product, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates pricing info for the provided Product and its related priceable entities: Variant, IncludedProduct, SpecificItemChoice.

Methods in com.broadleafcommerce.catalogbrowse.service.provider with parameters of type Product

Modifier and Type	Method	Description
Product	PricingProvider.priceProduct(Product product, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates pricing info for the provided Product and its related priceable entities: Variant, IncludedProduct, SpecificItemChoice.

Uses of Product in com.broadleafcommerce.catalogbrowse.service.provider.external.catalog

Methods in com.broadleafcommerce.catalogbrowse.service.provider.external.catalog with type parameters of type Product

Modifier and Type	Method	Description
<T extends Product> void	ExternalCatalogProvider.hydrateProductAssets(@NonNull Collection<T> products, org.springframework.util.MultiValueMap<String,String> parameters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected <T extends Product> List<T>	ExternalCatalogProvider.hydrateProductsAvailability(@NonNull List<T> toHydrate, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hydrates inventory availability onto the retrieved products.
protected <T extends Product> List<T>	ExternalCatalogProvider.hydrateProductsPricing(@NonNull List<T> toHydrate, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hydrates pricing onto the retrieved products.
<T extends Product> void	ExternalCatalogProvider.hydrateProductTags(@NonNull Collection<T> products, org.springframework.util.MultiValueMap<String,String> parameters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Uses of Product in com.broadleafcommerce.catalogbrowse.service.provider.external.inventory

Methods in com.broadleafcommerce.catalogbrowse.service.provider.external.inventory with type parameters of type Product

Modifier and Type	Method	Description
protected <P extends Product> Collection<P>	ExternalInventoryProvider.attachSummariesToProducts(@NonNull Collection<P> products, @NonNull Collection<SkuInventoryAvailabilitySummary> summaries, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Attaches inventory availability summaries to the products.
protected <P extends Product> Collection<SkuInventoryAvailabilityRequest>	ExternalInventoryProvider.buildSkuInventoryAvailabilityRequests(@NonNull Collection<P> products, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a list SkuInventoryAvailabilityRequest to verify the availability of the SKU for the provided quantity.
<P extends Product> Collection<P>	ExternalInventoryProvider.determineProductsInventoryAvailability(@NonNull Collection<P> products, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected <P extends Product> List<SkuInventoryAvailabilitySummary>	ExternalInventoryProvider.getInventorySummaries(@NonNull Collection<P> products, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected <P extends Product> boolean	ExternalInventoryProvider.productRequiresInventoryCheck(P product, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods in com.broadleafcommerce.catalogbrowse.service.provider.external.inventory with parameters of type Product

Modifier and Type	Method	Description
protected <V extends Variant> boolean	ExternalInventoryProvider.variantRequiresInventoryCheck(V variant, @NonNull Product product, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Uses of Product in com.broadleafcommerce.catalogbrowse.service.provider.external.pricing

Methods in com.broadleafcommerce.catalogbrowse.service.provider.external.pricing with type parameters of type Product

Modifier and Type	Method	Description
protected <P extends Product> List<P>	ExternalPricingProvider.attachPricingToProducts(@NonNull Collection<P> products, @NonNull Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>> targetsMap, @NonNull SimplePage<com.broadleafcommerce.pricing.client.domain.PriceInfo> priceInfos)	Deprecated. Use ExternalPricingProvider.attachPricingToProducts(Collection, Map, SimplePage, PriceContext) Passing the PriceContext supports proper filtering of PriceInfo results that are in the proper currency.
protected <P extends Product> List<P>	ExternalPricingProvider.attachPricingToProducts(@NonNull Collection<P> products, @NonNull Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>> targetsMap, @NonNull SimplePage<com.broadleafcommerce.pricing.client.domain.PriceInfo> priceInfos, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext)	Handles attaching the PriceInfos returned by the pricing service onto the Products and their related entities.
<P extends Product> List<P>	ExternalPricingProvider.priceProducts(@NonNull Collection<P> products, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates pricing info for the provided Products and their related priceable entities: Variant, IncludedProduct, SpecificItemChoice.

Methods in com.broadleafcommerce.catalogbrowse.service.provider.external.pricing that return Product

Modifier and Type	Method	Description
protected Product	ExternalPricingProvider.attachPricingToProduct(@NonNull Product product, @NonNull Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>> targetsMap, @NonNull SimplePage<com.broadleafcommerce.pricing.client.domain.PriceInfo> priceInfos)	Deprecated. Use ExternalPricingProvider.attachPricingToProduct(Product, Map, SimplePage, PriceContext) Passing the PriceContext supports proper filtering of PriceInfo results that are in the proper currency.
protected Product	ExternalPricingProvider.attachPricingToProduct(@NonNull Product product, @NonNull Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>> targetsMap, @NonNull SimplePage<com.broadleafcommerce.pricing.client.domain.PriceInfo> priceInfos, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext)	Handles attaching the PriceInfos returned by the pricing service onto the Product and its related entities.
Product	ExternalPricingProvider.priceProduct(@NonNull Product product, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates pricing info for the provided Product and its related priceable entities: Variant, IncludedProduct, SpecificItemChoice.

Methods in com.broadleafcommerce.catalogbrowse.service.provider.external.pricing with parameters of type Product

Modifier and Type	Method	Description
protected Product	ExternalPricingProvider.attachPricingToProduct(@NonNull Product product, @NonNull Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>> targetsMap, @NonNull SimplePage<com.broadleafcommerce.pricing.client.domain.PriceInfo> priceInfos)	Deprecated. Use ExternalPricingProvider.attachPricingToProduct(Product, Map, SimplePage, PriceContext) Passing the PriceContext supports proper filtering of PriceInfo results that are in the proper currency.
protected Product	ExternalPricingProvider.attachPricingToProduct(@NonNull Product product, @NonNull Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>> targetsMap, @NonNull SimplePage<com.broadleafcommerce.pricing.client.domain.PriceInfo> priceInfos, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext)	Handles attaching the PriceInfos returned by the pricing service onto the Product and its related entities.
Product	ExternalPricingProvider.priceProduct(@NonNull Product product, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates pricing info for the provided Product and its related priceable entities: Variant, IncludedProduct, SpecificItemChoice.

Uses of Product in com.broadleafcommerce.catalogbrowse.service.provider.external.pricing.product

Methods in com.broadleafcommerce.catalogbrowse.service.provider.external.pricing.product with parameters of type Product

Modifier and Type	Method	Description
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	BaseProductPriceableTargetsBuilder.buildTargetsForProduct(@NonNull Product product)
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	IncludedProductsProductPriceableTargetsBuilder.buildTargetsForProduct(@NonNull Product product)	Deprecated.
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	ProductOptionsProductPriceableTargetsBuilder.buildTargetsForProduct(@NonNull Product product)
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	ProductPriceableTargetsBuilder.buildTargetsForProduct(Product product)	Builds PriceableTargets for a single Product or one of its relationships such as its Variants.
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	PromotionalProductsProductPricingTargetsBuilder.buildTargetsForProduct(@NonNull Product product)
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	VariantsProductPriceableTargetsBuilder.buildTargetsForProduct(@NonNull Product product)
protected com.broadleafcommerce.pricing.client.domain.PriceableTarget	ProductPriceableTargetUtils.createTargetForLowestPricedSku(@NonNull SkuPricingPredicate lowestPricedSkuPredicate, @NonNull Product product)	Creates a PriceableTarget for the SkuPricingPredicate that represents the lowest priced sku.
protected com.broadleafcommerce.pricing.client.domain.PriceableTarget	ProductPriceableTargetUtils.createTargetForPricingKey(@NonNull Product product, @NonNull Map<String,javax.money.MonetaryAmount> priceableFields)	Creates the PriceableTarget for a Product using getPricingKey() as PriceableTarget.getTargetId().
protected com.broadleafcommerce.pricing.client.domain.PriceableTarget	VariantPriceableTargetUtils.createTargetForProductPricingKey(@NonNull Variant variant, @NonNull Product product, @NonNull Map<String,javax.money.MonetaryAmount> priceableFields)	Creates the PriceableTarget for a Variant using its owning product's pricingKey as PriceableTarget.getTargetId().
protected com.broadleafcommerce.pricing.client.domain.PriceableTarget	ProductPriceableTargetUtils.createTargetForSku(@NonNull Product product, @NonNull Map<String,javax.money.MonetaryAmount> priceableFields)	Creates the PriceableTarget for a Product using getSku() as PriceableTarget.getTargetId().
Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>	ProductPriceableTargetUtils.createTargets(@NonNull Product product)	Creates PriceableTargets for a Product.
Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>	VariantPriceableTargetUtils.createTargets(@NonNull Variant variant, Product product)	Creates PriceableTargets for a Variant.
protected Map<String,javax.money.MonetaryAmount>	ProductPriceableTargetUtils.getPriceableFields(@NonNull Product product)	Builds the map of priceable fields for a Product that will be added as PriceableTarget.getPriceableFields().
protected Map<String,javax.money.MonetaryAmount>	VariantPriceableTargetUtils.getPriceableFields(@NonNull Variant variant, Product product)	Builds the map of priceable fields for a Variant that will be added as PriceableTarget.getPriceableFields().
protected void	ProductPriceableTargetUtils.setCharacteristicsAndTerms(@NonNull Product product, com.broadleafcommerce.pricing.client.domain.PriceableTarget targetById)
protected void	VariantPriceableTargetUtils.setCharacteristicsAndTerms(Product product, com.broadleafcommerce.pricing.client.domain.PriceableTarget targetById)

Method parameters in com.broadleafcommerce.catalogbrowse.service.provider.external.pricing.product with type arguments of type Product

Modifier and Type	Method	Description
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	BaseProductPriceableTargetsBuilder.buildTargetsForProducts(@NonNull Collection<? extends Product> products)
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	IncludedProductsProductPriceableTargetsBuilder.buildTargetsForProducts(@NonNull Collection<? extends Product> products)	Deprecated.
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	ProductOptionsProductPriceableTargetsBuilder.buildTargetsForProducts(@NonNull Collection<? extends Product> products)
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	ProductPriceableTargetsBuilder.buildTargetsForProducts(Collection<? extends Product> products)	Builds PriceableTargets for multiple Products or one of the relationships such as their Variants.This returns a map where the key is the entity to which the PriceableTarget corresponds, which helps when mapping PriceInfos back onto the entity represented by the PriceableTarget.
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	PromotionalProductsProductPricingTargetsBuilder.buildTargetsForProducts(@NonNull Collection<? extends Product> products)
Map<Object,Set<com.broadleafcommerce.pricing.client.domain.PriceableTarget>>	VariantsProductPriceableTargetsBuilder.buildTargetsForProducts(@NonNull Collection<? extends Product> products)

Uses of Product in com.broadleafcommerce.catalogbrowse.service.provider.external.search

Classes in com.broadleafcommerce.catalogbrowse.service.provider.external.search with type parameters of type Product

Modifier and Type	Class	Description
class	ExternalCatalogSearchProvider<T extends Product>

Methods in com.broadleafcommerce.catalogbrowse.service.provider.external.search with parameters of type Product

Modifier and Type	Method	Description
protected void	ExternalCatalogSearchProvider.addPriceDetail(Product product, DefaultPriceableFieldType fieldType, javax.money.MonetaryAmount price, boolean replaceExisting)
protected void	ExternalCatalogSearchProvider.addPriceDetailFromProductData(Product product, DefaultPriceableFieldType fieldType, javax.money.MonetaryAmount price)
protected void	ExternalCatalogSearchProvider.addPriceDetailsFromProductData(Product product, ProductPricingPredicate predicate)	Add price details from product's data.
protected void	ExternalCatalogSearchProvider.overrideProductPriceDetailsWithSkuData(Product product, ProductPricingPredicate predicate)	By default, this method overrides the product prices for display in search with the values from the lowest priced sku.
protected ProductPricingPredicate	ExternalCatalogSearchProvider.parseProductPricingPredicate(Product product, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Attempts to fetch the ProductPricingPredicate from the search response, if it exists.
protected void	ExternalCatalogSearchProvider.updatePricingKeyFromPredicate(ProductPricingPredicate predicate, Product product)	Adds the pricing key from the predicate to the product if the product does not already have a pricing key value.

Uses of Product in com.broadleafcommerce.catalogbrowse.web.endpoint

Methods in com.broadleafcommerce.catalogbrowse.web.endpoint that return types with arguments of type Product

Modifier and Type	Method	Description
protected CatalogSearchProvider<Product>	CatalogBrowseEndpoint.getBrowseCatalogSearchProvider()
SearchResponse<Product>	CatalogBrowseEndpoint.getCatalogSearchResults(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, org.springframework.util.MultiValueMap<String,String> parameters)	TODO: The /search/catalog mapping should be removed in the future as we will want to deprecate it in favor of /browse/search/catalog.

Constructor parameters in com.broadleafcommerce.catalogbrowse.web.endpoint with type arguments of type Product

Modifier	Constructor	Description
	CatalogBrowseEndpoint(CatalogProvider browseCatalogProvider, BrowseEntityResolver browseEntityResolver, CatalogSearchProvider<Product> browseCatalogSearchProvider, OfferProvider browseOfferProvider, MarketingMessageUtils marketingMessageUtils, com.broadleafcommerce.common.extension.TypeFactory typeFactory)