org.broadleafcommerce.core.order.service

Interface OrderServiceExtensionHandler

All Superinterfaces:

ExtensionHandler

All Known Implementing Classes:

AbstractOrderServiceExtensionHandler, CartMessageOrderItemServiceExtensionHandler, OrderServiceExtensionManager

public interface OrderServiceExtensionHandler
extends ExtensionHandler

Author:

Andre Azzolini (apazzolini), bpolster

Method Summary

Modifier and Type	Method and Description
ExtensionResultStatusType	addOfferCodes(Order order, List<OfferCode> offerCodes, boolean priceOrder)
ExtensionResultStatusType	attachAdditionalDataToNewNamedCart(Customer customer, Order cart)
ExtensionResultStatusType	attachAdditionalDataToOrder(Order order, boolean priceOrder) Can be used to attach or update fields must prior to saving an order.
ExtensionResultStatusType	findCartForCustomerWithEnhancements(Customer customer, ExtensionResultHolder erh) Retrieve an enhanced version of the cart for the customer.
ExtensionResultStatusType	findCartForCustomerWithEnhancements(Customer customer, Order candidateCart, ExtensionResultHolder erh) Retrieve an enhanced version of the cart for the customer.
ExtensionResultStatusType	preValidateCartOperation(Order cart, ExtensionResultHolder erh)
ExtensionResultStatusType	preValidateUpdateQuantityOperation(Order cart, OrderItemRequestDTO dto, ExtensionResultHolder erh)

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Method Detail

attachAdditionalDataToNewNamedCart

ExtensionResultStatusType attachAdditionalDataToNewNamedCart(Customer customer,
                                                             Order cart)

preValidateCartOperation

ExtensionResultStatusType preValidateCartOperation(Order cart,
                                                   ExtensionResultHolder erh)

preValidateUpdateQuantityOperation

ExtensionResultStatusType preValidateUpdateQuantityOperation(Order cart,
                                                             OrderItemRequestDTO dto,
                                                             ExtensionResultHolder erh)

attachAdditionalDataToOrder

ExtensionResultStatusType attachAdditionalDataToOrder(Order order,
                                                      boolean priceOrder)

Can be used to attach or update fields must prior to saving an order.

Returns:

addOfferCodes

ExtensionResultStatusType addOfferCodes(Order order,
                                        List<OfferCode> offerCodes,
                                        boolean priceOrder)

findCartForCustomerWithEnhancements

ExtensionResultStatusType findCartForCustomerWithEnhancements(Customer customer,
                                                              ExtensionResultHolder erh)

Retrieve an enhanced version of the cart for the customer. Individual instances of OrderServiceExtensionHandler can provide one or more interesting enhancements.

Parameters:

customer - the user for whom the cart is retrieved

erh - the holder for the enhanced cart to be set by the handler

Returns:

whether or not the enhancement was performed

findCartForCustomerWithEnhancements

ExtensionResultStatusType findCartForCustomerWithEnhancements(Customer customer,
                                                              Order candidateCart,
                                                              ExtensionResultHolder erh)

Retrieve an enhanced version of the cart for the customer. Use the candidateCart as the source cart to be enhanced. Individual instances of OrderServiceExtensionHandler can provide one or more interesting enhancements.

Parameters:

customer - the user for whom the cart is enhanced

candidateCart - the source cart to enhance

erh - the holder for the enhanced cart to be set by the handler

Returns:

whether or not the enhancement was performed