com.broadleafcommerce.cartoperation.service.pricing

Class DefaultFulfillmentPricingService

java.lang.Object

com.broadleafcommerce.cartoperation.service.pricing.DefaultFulfillmentPricingService

All Implemented Interfaces:

FulfillmentPricingService

public class DefaultFulfillmentPricingService
extends Object
implements FulfillmentPricingService

Author:

Chad Harchar (charchar)

Constructor Summary

Constructors

Constructor and Description
DefaultFulfillmentPricingService(com.fasterxml.jackson.databind.ObjectMapper mapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory, List<com.broadleafcommerce.shipping.FulfillmentPricingProvider> fulfillmentPricingProviders, CartOperationServiceProperties cartOperationServiceProperties)

Method Summary

Modifier and Type	Method and Description
void	applyFulfillmentPricing(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart) Service for calculating and applying fulfillment pricing to a Cart, typically by integrating with one or more FulfillmentPricingProviders.
protected void	applyFulfillmentPricingForGroup(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull com.broadleafcommerce.cart.client.domain.FulfillmentGroup fulfillmentGroup) Sends a pricing request to the FulfillmentPricingProvider that can calculate the cost for the FulfillmentGroup's set FulfillmentOption and sets the group's pricing fields based on the response.
protected void	applyProductVariantAttributes(@NonNull com.broadleafcommerce.cart.client.domain.FulfillmentItem fulfillmentItem, @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingItem fulfillmentPricingItem, @NonNull com.broadleafcommerce.cart.client.domain.CartItem cartItem)
protected com.broadleafcommerce.shipping.domain.FulfillmentPricingItem	buildFulfillmentPricingItem(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull com.broadleafcommerce.cart.client.domain.FulfillmentItem fulfillmentItem)
protected com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest	buildFulfillmentPricingRequest(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String fulfillmentGroupId)
boolean	canCalculateFulfillmentPricing(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart) Whether the cart contains the information required to calculate fulfillment pricing.
protected com.broadleafcommerce.cart.client.domain.CartItem	getCartItemForFulfillmentItem(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull com.broadleafcommerce.cart.client.domain.FulfillmentItem fi)
protected CartOperationServiceProperties	getCartOperationServiceProperties()
protected List<com.broadleafcommerce.shipping.FulfillmentPricingProvider>	getFulfillmentPricingProviders()
protected com.fasterxml.jackson.databind.ObjectMapper	getMapper()
List<com.broadleafcommerce.shipping.domain.FulfillmentOptionPricedResponse>	getOptions(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, @NonNull String referenceNumber) A list of all potential fulfillment options for the specified cart and fulfillment group.
protected com.broadleafcommerce.shipping.domain.ShippingAddress	getShippingAddress(com.broadleafcommerce.order.common.domain.Address fgAddress)
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFulfillmentPricingService

public DefaultFulfillmentPricingService(com.fasterxml.jackson.databind.ObjectMapper mapper,
                                        com.broadleafcommerce.common.extension.TypeFactory typeFactory,
                                        List<com.broadleafcommerce.shipping.FulfillmentPricingProvider> fulfillmentPricingProviders,
                                        CartOperationServiceProperties cartOperationServiceProperties)

Method Detail

applyFulfillmentPricing

public void applyFulfillmentPricing(@NonNull
                                    @NonNull com.broadleafcommerce.cart.client.domain.Cart cart)

Description copied from interface: FulfillmentPricingService

Service for calculating and applying fulfillment pricing to a Cart, typically by integrating with one or more FulfillmentPricingProviders. Options are expected to be unique across all providers, once a provider is found that can handle an option, it will be the one used for calculation.

Specified by:

applyFulfillmentPricing in interface FulfillmentPricingService

Parameters:

cart - The cart to apply fulfillment pricing against.

canCalculateFulfillmentPricing

public boolean canCalculateFulfillmentPricing(@NonNull
                                              @NonNull com.broadleafcommerce.cart.client.domain.Cart cart)

Description copied from interface: FulfillmentPricingService

Whether the cart contains the information required to calculate fulfillment pricing.

Specified by:

canCalculateFulfillmentPricing in interface FulfillmentPricingService

Parameters:

cart - The cart to determine whether fulfillment pricing can be calculated for.

Returns:

Whether the cart contains the information required to calculate fulfillment pricing.

getOptions

public List<com.broadleafcommerce.shipping.domain.FulfillmentOptionPricedResponse> getOptions(@NonNull
                                                                                              @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                              @NonNull
                                                                                              @NonNull String referenceNumber)

Description copied from interface: FulfillmentPricingService

A list of all potential fulfillment options for the specified cart and fulfillment group.

Specified by:

getOptions in interface FulfillmentPricingService

Parameters:

cart - The cart to determine which fulfillment options can be chosen.

referenceNumber - The id of the fulfillment group we are retrieving options for.

Returns:

A list of all potential fulfillment options for the specified cart and fulfillment group.

applyFulfillmentPricingForGroup

protected void applyFulfillmentPricingForGroup(@NonNull
                                               @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                               @NonNull
                                               @NonNull com.broadleafcommerce.cart.client.domain.FulfillmentGroup fulfillmentGroup)

Sends a pricing request to the FulfillmentPricingProvider that can calculate the cost for the FulfillmentGroup's set FulfillmentOption and sets the group's pricing fields based on the response.

Parameters:

cart - The Cart that owns the fulfillmentGroup

fulfillmentGroup - The FulfillmentGroup to be priced

buildFulfillmentPricingRequest

protected com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest buildFulfillmentPricingRequest(@NonNull
                                                                                                         @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                                         @NonNull
                                                                                                         @NonNull String fulfillmentGroupId)

buildFulfillmentPricingItem

protected com.broadleafcommerce.shipping.domain.FulfillmentPricingItem buildFulfillmentPricingItem(@NonNull
                                                                                                   @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                                   @NonNull
                                                                                                   @NonNull com.broadleafcommerce.cart.client.domain.FulfillmentItem fulfillmentItem)

applyProductVariantAttributes

protected void applyProductVariantAttributes(@NonNull
                                             @NonNull com.broadleafcommerce.cart.client.domain.FulfillmentItem fulfillmentItem,
                                             @NonNull
                                             @NonNull com.broadleafcommerce.shipping.domain.FulfillmentPricingItem fulfillmentPricingItem,
                                             @NonNull
                                             @NonNull com.broadleafcommerce.cart.client.domain.CartItem cartItem)

getCartItemForFulfillmentItem

protected com.broadleafcommerce.cart.client.domain.CartItem getCartItemForFulfillmentItem(@NonNull
                                                                                          @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
                                                                                          @NonNull
                                                                                          @NonNull com.broadleafcommerce.cart.client.domain.FulfillmentItem fi)

getShippingAddress

@Nullable
protected com.broadleafcommerce.shipping.domain.ShippingAddress getShippingAddress(@Nullable
                                                                                             com.broadleafcommerce.order.common.domain.Address fgAddress)

getMapper

protected com.fasterxml.jackson.databind.ObjectMapper getMapper()

getTypeFactory

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

getFulfillmentPricingProviders

protected List<com.broadleafcommerce.shipping.FulfillmentPricingProvider> getFulfillmentPricingProviders()

getCartOperationServiceProperties

protected CartOperationServiceProperties getCartOperationServiceProperties()