com.broadleafcommerce.cartoperation.service.configuration

Class DefaultIncludedProductConfigurationService

java.lang.Object

com.broadleafcommerce.cartoperation.service.configuration.DefaultIncludedProductConfigurationService

All Implemented Interfaces:

IncludedProductConfigurationService

public class DefaultIncludedProductConfigurationService
extends Object
implements IncludedProductConfigurationService

Author:

Chad Harchar (charchar)

Constructor Summary

Constructors

Constructor and Description
DefaultIncludedProductConfigurationService(org.springframework.context.MessageSource messageSource, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method and Description
protected void	addItemConfigError(@NonNull com.broadleafcommerce.cart.client.domain.CartItem cartItem, @NonNull IncludedProduct includedProduct, @NonNull String errorCode, @NonNull String errorMessage)
protected com.broadleafcommerce.cart.client.domain.CartItem	createDependentItem(@NonNull IncludedProduct includedProduct)
protected Optional<com.broadleafcommerce.cart.client.domain.CartItem>	findDependentMatchingIncludedProduct(@NonNull List<com.broadleafcommerce.cart.client.domain.CartItem> dependentCartItems, @NonNull IncludedProduct includedProduct)
protected Optional<com.broadleafcommerce.cart.client.domain.CartItem>	findMatchingProduct(@NonNull List<com.broadleafcommerce.cart.client.domain.CartItem> dependentCartItems, @NonNull IncludedProduct includedProduct)
protected Optional<com.broadleafcommerce.cart.client.domain.CartItem>	findMatchingVariant(@NonNull List<com.broadleafcommerce.cart.client.domain.CartItem> dependentCartItems, @NonNull IncludedProduct includedProduct)
protected javax.money.MonetaryAmount	getIncludedItemUnitPrice(@NonNull IncludedProduct includedProduct) Returns the "unitPrice" of the IncludedProduct to use for a CartItem.
protected String	getIncludedProductName(@NonNull IncludedProduct includedProduct) Returns the "name" of the IncludedProduct to use for a CartItem.
protected String	getMessage(@NonNull String errorMessage, Object... args)
protected org.springframework.context.MessageSource	getMessageSource()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
void	populateIncludedProduct(@NonNull com.broadleafcommerce.cart.client.domain.CartItem cartItem, @NonNull IncludedProduct includedProduct, @NonNull List<com.broadleafcommerce.cart.client.domain.CartItem> potentialDependentItems, boolean isAdd) Populate the IncludedProduct as a dependent item in the provided CartItem.
void	validateIncludedProduct(@NonNull com.broadleafcommerce.cart.client.domain.CartItem cartItem, @NonNull IncludedProduct includedProduct, @NonNull List<com.broadleafcommerce.cart.client.domain.CartItem> potentialDependentItems) Perform validation against the provided CartItem for the given IncludedProduct.
protected void	validateQuantity(@NonNull com.broadleafcommerce.cart.client.domain.CartItem cartItem, com.broadleafcommerce.cart.client.domain.CartItem matchingCartItem, @NonNull IncludedProduct includedProduct)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIncludedProductConfigurationService

public DefaultIncludedProductConfigurationService(org.springframework.context.MessageSource messageSource,
                                                  com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Detail

populateIncludedProduct

public void populateIncludedProduct(@NonNull
                                    @NonNull com.broadleafcommerce.cart.client.domain.CartItem cartItem,
                                    @NonNull
                                    @NonNull IncludedProduct includedProduct,
                                    @NonNull
                                    @NonNull List<com.broadleafcommerce.cart.client.domain.CartItem> potentialDependentItems,
                                    boolean isAdd)

Description copied from interface: IncludedProductConfigurationService

Populate the IncludedProduct as a dependent item in the provided CartItem. If there is already an item in CartItem.getDependentCartItems() which matches the IncludedProduct, then that will be hydrated with pricing information. Otherwise, a new dependent cart item will be added to represent the IncludedProduct if we are in an add-to-cart flow.

Specified by:

populateIncludedProduct in interface IncludedProductConfigurationService

Parameters:

cartItem - The CartItem for which to populate the IncludedProduct.

includedProduct - The IncludedProduct we are populating.

potentialDependentItems - The list of CartItem.getDependentCartItems() to pick from to find a match for the IncludedProduct.

isAdd - Whether we are in an add-to-cart flow, which dictates whether to add an unmatched IncludedProduct.

findDependentMatchingIncludedProduct

protected Optional<com.broadleafcommerce.cart.client.domain.CartItem> findDependentMatchingIncludedProduct(@NonNull
                                                                                                           @NonNull List<com.broadleafcommerce.cart.client.domain.CartItem> dependentCartItems,
                                                                                                           @NonNull
                                                                                                           @NonNull IncludedProduct includedProduct)

findMatchingProduct

protected Optional<com.broadleafcommerce.cart.client.domain.CartItem> findMatchingProduct(@NonNull
                                                                                          @NonNull List<com.broadleafcommerce.cart.client.domain.CartItem> dependentCartItems,
                                                                                          @NonNull
                                                                                          @NonNull IncludedProduct includedProduct)

findMatchingVariant

protected Optional<com.broadleafcommerce.cart.client.domain.CartItem> findMatchingVariant(@NonNull
                                                                                          @NonNull List<com.broadleafcommerce.cart.client.domain.CartItem> dependentCartItems,
                                                                                          @NonNull
                                                                                          @NonNull IncludedProduct includedProduct)

createDependentItem

protected com.broadleafcommerce.cart.client.domain.CartItem createDependentItem(@NonNull
                                                                                @NonNull IncludedProduct includedProduct)

getIncludedProductName

protected String getIncludedProductName(@NonNull
                                        @NonNull IncludedProduct includedProduct)

Returns the "name" of the IncludedProduct to use for a CartItem. This defaults to the label, but if not present it will defer to the specific Variant or Product's name.

Parameters:

includedProduct - the IncludedProduct for which to determine a name

Returns:

the "name" of the IncludedProduct to use for a CartItem

getIncludedItemUnitPrice

protected javax.money.MonetaryAmount getIncludedItemUnitPrice(@NonNull
                                                              @NonNull IncludedProduct includedProduct)

Returns the "unitPrice" of the IncludedProduct to use for a CartItem. This defaults to the overridePrice, but if not present it will defer to the specific Variant or Product's price.

Parameters:

includedProduct - the IncludedProduct for which to determine a unitPrice

Returns:

the "unitPrice" of the IncludedProduct to use for a CartItem

validateIncludedProduct

public void validateIncludedProduct(@NonNull
                                    @NonNull com.broadleafcommerce.cart.client.domain.CartItem cartItem,
                                    @NonNull
                                    @NonNull IncludedProduct includedProduct,
                                    @NonNull
                                    @NonNull List<com.broadleafcommerce.cart.client.domain.CartItem> potentialDependentItems)

Description copied from interface: IncludedProductConfigurationService

Perform validation against the provided CartItem for the given IncludedProduct.

Specified by:

validateIncludedProduct in interface IncludedProductConfigurationService

Parameters:

cartItem - The CartItem to perform included product validation against.

includedProduct - The IncludedProduct we are using to validate the cart against.

potentialDependentItems - The list of dependent cart items to pick from when validating IncludedProduct.

validateQuantity

protected void validateQuantity(@NonNull
                                @NonNull com.broadleafcommerce.cart.client.domain.CartItem cartItem,
                                @Nullable
                                com.broadleafcommerce.cart.client.domain.CartItem matchingCartItem,
                                @NonNull
                                @NonNull IncludedProduct includedProduct)

getMessage

protected String getMessage(@NonNull
                            @NonNull String errorMessage,
                            @Nullable
                            Object... args)

addItemConfigError

protected void addItemConfigError(@NonNull
                                  @NonNull com.broadleafcommerce.cart.client.domain.CartItem cartItem,
                                  @NonNull
                                  @NonNull IncludedProduct includedProduct,
                                  @NonNull
                                  @NonNull String errorCode,
                                  @NonNull
                                  @NonNull String errorMessage)

getMessageSource

protected org.springframework.context.MessageSource getMessageSource()

getTypeFactory

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