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

Class PriceInfoContributionUtils

java.lang.Object

com.broadleafcommerce.catalog.service.util.commerce.PriceInfoContributionUtils

public class PriceInfoContributionUtils
extends Object

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

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
PriceInfoContributionUtils(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected void	addCostDetail(@NonNull Map<String,PriceTypeDetail> priceTypeDetails, @NonNull Variant variant, Product product)
protected void	addDefaultPriceDetail(@NonNull Map<String,PriceTypeDetail> priceTypeDetails, @NonNull Variant variant, Product product)
protected void	addDetail(Map<String,PriceTypeDetail> priceTypeDetails, String detailType, javax.money.MonetaryAmount amountForType, boolean amountIsFromVariant)
protected void	addSalePriceDetail(@NonNull Map<String,PriceTypeDetail> priceTypeDetails, @NonNull Variant variant, Product product)
PriceInfo	createItemChoicePriceInfo(@NonNull ItemChoice itemChoice)	Creates a PriceInfo for an ItemChoice
protected PriceInfo	createPriceInfoForCustomSpecificItem(@NonNull SpecificItemChoiceDetail specificItemChoice)	Extension point for creating a PriceInfo for a SpecificItemChoiceDetail if its type can be more than DefaultSpecificItemChoiceType.PRODUCT or DefaultSpecificItemChoiceType.VARIANT when it and its parent ItemChoice have no overridePrices.
PriceInfo	createPriceInfoForIncludedProduct(@NonNull IncludedProduct includedProduct)	Creates a PriceInfo for an IncludedProduct.
PriceInfo	createPriceInfoForProduct(@NonNull Product product)	Creates a PriceInfo for a Product.
protected PriceInfo	createPriceInfoForSpecificItem(@NonNull Map<String,javax.money.MonetaryAmount> pricingFields, boolean isOnSale)	Creates a PriceInfo with PriceTypeDetails appropriate for a Product, Variant, or similar entity.
PriceInfo	createPriceInfoForVariant(@NonNull Variant variant)	Creates a PriceInfo for a Variant.
PriceInfo	createPriceInfoForVariant(@NonNull Variant variant, Product parentProduct)	Creates a PriceInfo for a Variant optionally using the parentProduct pricing fields as fallbacks.
protected PriceInfo	createPriceInfoSpecificChoiceWithoutOverride(@NonNull SpecificItemChoiceDetail specificChoice, PriceInfo itemChoicePriceInfo)	Creates a PriceInfo for a SpecificItemChoice that does not have a SpecificItemChoice.getOverridePrice().
PriceInfo	createSpecificItemChoicePriceInfo(@NonNull SpecificItemChoiceDetail specificChoice, PriceInfo itemChoicePriceInfo)	Creates a PriceInfo for a SpecificItemChoiceDetail.
PriceInfo	createSpecificItemVariantPriceInfo(SpecificItemVariantPricing variantPricing)
protected PriceInfo	getPriceInfoForSpecificChoiceWithOverride(@NonNull SpecificItemChoiceDetail specificChoice)	Creates a PriceInfo for a SpecificItemChoice that has a SpecificItemChoice.getOverridePrice().
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected boolean	isOnSale(PriceTypeDetail priceDetail, PriceTypeDetail saleDetail)
protected void	updateVariantPriceInfo(@NonNull Variant variant, @NonNull PriceInfo priceInfo, @NonNull Map<String,PriceTypeDetail> priceTypeDetails)

Methods inherited from class java.lang.Object

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

Constructor Details

PriceInfoContributionUtils

public PriceInfoContributionUtils(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

createPriceInfoForProduct

public PriceInfo createPriceInfoForProduct(@NonNull
 @NonNull Product product)

Creates a PriceInfo for a Product.

Parameters:

product - The Product for which to create a PriceInfo

Returns:

a PriceInfo for a Product.

createPriceInfoForVariant

public PriceInfo createPriceInfoForVariant(@NonNull
 @NonNull Variant variant)

Creates a PriceInfo for a Variant.

Parameters:

variant - The Variant for which to create a PriceInfo

Returns:

a PriceInfo for a Variant.

createPriceInfoForVariant

public PriceInfo createPriceInfoForVariant(@NonNull
 @NonNull Variant variant,
 @Nullable
 Product parentProduct)

Creates a PriceInfo for a Variant optionally using the parentProduct pricing fields as fallbacks.

Parameters:

variant - The Variant for which to create a PriceInfo

parentProduct - The parent of the variant whose pricing to use a fallbacks if the variant is missing them

Returns:

a PriceInfo for a Variant optionally using the parentProduct pricing fields as fallbacks.

updateVariantPriceInfo

protected void updateVariantPriceInfo(@NonNull
 @NonNull Variant variant,
 @NonNull
 @NonNull PriceInfo priceInfo,
 @NonNull
 @NonNull Map<String,PriceTypeDetail> priceTypeDetails)

isOnSale

protected boolean isOnSale(PriceTypeDetail priceDetail,
 PriceTypeDetail saleDetail)

addCostDetail

protected void addCostDetail(@NonNull
 @NonNull Map<String,PriceTypeDetail> priceTypeDetails,
 @NonNull
 @NonNull Variant variant,
 @Nullable
 Product product)

addSalePriceDetail

protected void addSalePriceDetail(@NonNull
 @NonNull Map<String,PriceTypeDetail> priceTypeDetails,
 @NonNull
 @NonNull Variant variant,
 @Nullable
 Product product)

addDefaultPriceDetail

protected void addDefaultPriceDetail(@NonNull
 @NonNull Map<String,PriceTypeDetail> priceTypeDetails,
 @NonNull
 @NonNull Variant variant,
 @Nullable
 Product product)

addDetail

protected void addDetail(Map<String,PriceTypeDetail> priceTypeDetails,
 String detailType,
 javax.money.MonetaryAmount amountForType,
 boolean amountIsFromVariant)

createPriceInfoForIncludedProduct

public PriceInfo createPriceInfoForIncludedProduct(@NonNull
 @NonNull IncludedProduct includedProduct)

Creates a PriceInfo for an IncludedProduct.

Parameters:

includedProduct - IncludedProduct for which to create a PriceInfo

Returns:

a PriceInfo for an IncludedProduct

createItemChoicePriceInfo

public PriceInfo createItemChoicePriceInfo(@NonNull
 @NonNull ItemChoice itemChoice)

Creates a PriceInfo for an ItemChoice

Parameters:

itemChoice - ItemChoice for which to make a PriceInfo

Returns:

a PriceInfo for an ItemChoice

createSpecificItemChoicePriceInfo

public PriceInfo createSpecificItemChoicePriceInfo(@NonNull
 @NonNull SpecificItemChoiceDetail specificChoice,
 @Nullable
 PriceInfo itemChoicePriceInfo)

Creates a PriceInfo for a SpecificItemChoiceDetail. This will first look for an override price on the specific item, then on the parent ItemChoice, and, if neither of the previous are present, it will use the specific Product or Variant.

Parameters:

specificChoice - SpecificItemChoice for which to make a PriceInfo

Returns:

a PriceInfo for a SpecificItemChoiceDetail

createSpecificItemVariantPriceInfo

public PriceInfo createSpecificItemVariantPriceInfo(SpecificItemVariantPricing variantPricing)

getPriceInfoForSpecificChoiceWithOverride

protected PriceInfo getPriceInfoForSpecificChoiceWithOverride(@NonNull
 @NonNull SpecificItemChoiceDetail specificChoice)

Creates a PriceInfo for a SpecificItemChoice that has a SpecificItemChoice.getOverridePrice().

Parameters:

specificChoice - SpecificItemChoice for which to create a PriceInfo

Returns:

a PriceInfo for a SpecificItemChoice that has a SpecificItemChoice.getOverridePrice().

createPriceInfoSpecificChoiceWithoutOverride

protected PriceInfo createPriceInfoSpecificChoiceWithoutOverride(@NonNull
 @NonNull SpecificItemChoiceDetail specificChoice,
 @Nullable
 PriceInfo itemChoicePriceInfo)

Creates a PriceInfo for a SpecificItemChoice that does not have a SpecificItemChoice.getOverridePrice().

Parameters:

specificChoice - SpecificItemChoice for which to create a PriceInfo

itemChoicePriceInfo - The PriceInfo of the parent ItemChoice

Returns:

a PriceInfo for a SpecificItemChoice that does not have a SpecificItemChoice.getOverridePrice().

createPriceInfoForSpecificItem

protected PriceInfo createPriceInfoForSpecificItem(@NonNull
 @NonNull Map<String,javax.money.MonetaryAmount> pricingFields,
 boolean isOnSale)

Creates a PriceInfo with PriceTypeDetails appropriate for a Product, Variant, or similar entity. Normally, this means that it will look at the pricing fields of a Variant or Product; however, the method has been generalized to take in any number of arbitrary pricing fields.

Parameters:

pricingFields - An arbitrary set of pricing fields. By default the keys should match the values of DefaultPriceType.

isOnSale - Whether the item is on sale.

Returns:

a PriceInfo with PriceTypeDetails appropriate for a Product, Variant, or similar entity

createPriceInfoForCustomSpecificItem

protected PriceInfo createPriceInfoForCustomSpecificItem(@NonNull
 @NonNull SpecificItemChoiceDetail specificItemChoice)

Extension point for creating a PriceInfo for a SpecificItemChoiceDetail if its type can be more than DefaultSpecificItemChoiceType.PRODUCT or DefaultSpecificItemChoiceType.VARIANT when it and its parent ItemChoice have no overridePrices.

Parameters:

specificItemChoice - The SpecificItemChoiceDetail for which to make a PriceInfo

Returns:

A PriceInfo for a SpecificItemChoiceDetail when neither it nor its parent ItemChoice have overridePrices.

getTypeFactory

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