Package com.broadleafcommerce.catalog.service.product.commerce.util

Class ProductOptionContributionUtils

java.lang.Object

com.broadleafcommerce.catalog.service.product.commerce.util.ProductOptionContributionUtils

public class ProductOptionContributionUtils
extends Object

Utility methods for ProductOptionDetails created for the response to a ProductDetailsRequest.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
ProductOptionContributionUtils(PriceInfoContributionUtils priceInfoContributionUtils, CatalogServiceProperties properties, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected ItemChoiceCategory	buildItemChoiceCategory(ProductDetailsContext product, ItemChoice itemChoice, boolean narrowChoices)	Builds out and prunes the category item choices.
protected List<SpecificItemChoiceDetail>	buildSpecificItemChoices(ProductDetailsContext productDetailsContext, ItemChoice itemChoice, PriceInfo priceInfo, boolean narrowChoices)	Builds out and prunes the specific item choices.
protected ItemChoiceDetail	createItemChoiceDetail(@NonNull ItemChoice itemChoice, @NonNull ProductDetailsContext productDetailsContext, boolean narrowChoices)
ProductOptionDetail	createProductOptionDetail(@NonNull ProductOption option, @NonNull ProductDetailsContext productDetailsContext, boolean narrowChoices)	Creates a ProductOptionDetail for a ProductOption included its embedded relationships.
protected SpecificItemChoiceDetail	createSpecificItemChoiceDetails(@NonNull SpecificItemChoice specificChoice, @NonNull ProductDetailsContext productDetailsContext, PriceInfo itemChoicePriceInfo)
protected PriceInfoContributionUtils	getPriceInfoContributionUtils()
protected CatalogServiceProperties	getProperties()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected ItemChoiceDetail	populateItemChoiceDefaults(@NonNull ItemChoiceDetail itemChoice, @NonNull ProductDetailsContext productDetailsContext)
protected SpecificItemChoiceDetail	populateSpecificChoice(@NonNull SpecificItemChoiceDetail specificChoice, @NonNull ProductDetailsContext productDetailsContext)
protected Optional<ProductDetails>	recursivelyNarrowItemChoices(ProductDetails product, Map<String,ProductDetails> relatedProducts, Map<String,VariantDetail> relatedVariants, Set<String> invalidProductChoiceIds, int currentDepth)	Recursively builds out and prunes the item choices for the product.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProductOptionContributionUtils

public ProductOptionContributionUtils(PriceInfoContributionUtils priceInfoContributionUtils,
 CatalogServiceProperties properties,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

createProductOptionDetail

public ProductOptionDetail createProductOptionDetail(@NonNull
 @NonNull ProductOption option,
 @NonNull
 @NonNull ProductDetailsContext productDetailsContext,
 boolean narrowChoices)

Creates a ProductOptionDetail for a ProductOption included its embedded relationships.

Parameters:

option - The ProductOption for which to make a ProductOptionDetail

productDetailsContext - The relevant ProductDetailsContext

Returns:

a ProductOptionDetail for a ProductOption

createItemChoiceDetail

protected ItemChoiceDetail createItemChoiceDetail(@NonNull
 @NonNull ItemChoice itemChoice,
 @NonNull
 @NonNull ProductDetailsContext productDetailsContext,
 boolean narrowChoices)

populateItemChoiceDefaults

protected ItemChoiceDetail populateItemChoiceDefaults(@NonNull
 @NonNull ItemChoiceDetail itemChoice,
 @NonNull
 @NonNull ProductDetailsContext productDetailsContext)

createSpecificItemChoiceDetails

protected SpecificItemChoiceDetail createSpecificItemChoiceDetails(@NonNull
 @NonNull SpecificItemChoice specificChoice,
 @NonNull
 @NonNull ProductDetailsContext productDetailsContext,
 @Nullable
 PriceInfo itemChoicePriceInfo)

populateSpecificChoice

protected SpecificItemChoiceDetail populateSpecificChoice(@NonNull
 @NonNull SpecificItemChoiceDetail specificChoice,
 @NonNull
 @NonNull ProductDetailsContext productDetailsContext)

buildItemChoiceCategory

@Nullable
protected ItemChoiceCategory buildItemChoiceCategory(ProductDetailsContext product,
 ItemChoice itemChoice,
 boolean narrowChoices)

Builds out and prunes the category item choices. This is responsible for starting the recursive pruning for item choices of type DefaultItemChoiceTargetType.CATEGORY.

Parameters:

product - The relevant ProductDetailsContext

itemChoice - The relevant ItemChoice

narrowChoices - Whether or not to narrow the category item choices

Returns:

The valid ItemChoiceCategory for this item choice.

recursivelyNarrowItemChoices

protected Optional<ProductDetails> recursivelyNarrowItemChoices(ProductDetails product,
 Map<String,ProductDetails> relatedProducts,
 Map<String,VariantDetail> relatedVariants,
 Set<String> invalidProductChoiceIds,
 int currentDepth)

Recursively builds out and prunes the item choices for the product.

Parameters:

product - The product to narrow the item choices on

relatedProducts - The relevant related products

relatedVariants - The relevant related variants

invalidProductChoiceIds - The set of invalid product choice IDs

currentDepth - The current depth of the recursion

Returns:

The product after its item choices have been pruned.

buildSpecificItemChoices

protected List<SpecificItemChoiceDetail> buildSpecificItemChoices(ProductDetailsContext productDetailsContext,
 ItemChoice itemChoice,
 PriceInfo priceInfo,
 boolean narrowChoices)

Builds out and prunes the specific item choices. This is responsible for starting the recursive pruning for item choices of type DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS and DefaultItemChoiceTargetType.SPECIFIC_VARIANTS. Note: Specific variant item choices are not configurable and therefore do not require recursive pruning.

Parameters:

productDetailsContext - The relevant ProductDetailsContext

itemChoice - The relevant ItemChoice

priceInfo - The relevant PriceInfo for the item choice

narrowChoices - Whether or not to narrow the product item choices

Returns:

The list of valid specific item choice details.

getPriceInfoContributionUtils

protected PriceInfoContributionUtils getPriceInfoContributionUtils()

getProperties

protected CatalogServiceProperties getProperties()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()