Package org.broadleafcommerce.core.order.service

Class AbstractOrderServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.core.order.service.AbstractOrderServiceExtensionHandler

All Implemented Interfaces:

ExtensionHandler, OrderServiceExtensionHandler

Direct Known Subclasses:

CartMessageOrderItemServiceExtensionHandler

public abstract class AbstractOrderServiceExtensionHandler
extends AbstractExtensionHandler
implements OrderServiceExtensionHandler

Author:

bpolster

Field Summary

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor	Description
AbstractOrderServiceExtensionHandler()

Method Summary

Modifier and Type	Method	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 class org.broadleafcommerce.common.extension.AbstractExtensionHandler

getPriority, isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

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

getPriority, isEnabled

Constructor Details

AbstractOrderServiceExtensionHandler

public AbstractOrderServiceExtensionHandler()

Method Details

attachAdditionalDataToNewNamedCart

public ExtensionResultStatusType attachAdditionalDataToNewNamedCart(Customer customer,
 Order cart)

Specified by:

attachAdditionalDataToNewNamedCart in interface OrderServiceExtensionHandler

preValidateCartOperation

public ExtensionResultStatusType preValidateCartOperation(Order cart,
 ExtensionResultHolder erh)

Specified by:

preValidateCartOperation in interface OrderServiceExtensionHandler

preValidateUpdateQuantityOperation

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

Specified by:

preValidateUpdateQuantityOperation in interface OrderServiceExtensionHandler

attachAdditionalDataToOrder

public ExtensionResultStatusType attachAdditionalDataToOrder(Order order,
 boolean priceOrder)

Description copied from interface: OrderServiceExtensionHandler

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

Specified by:

attachAdditionalDataToOrder in interface OrderServiceExtensionHandler

Returns:

addOfferCodes

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

Specified by:

addOfferCodes in interface OrderServiceExtensionHandler

findCartForCustomerWithEnhancements

public ExtensionResultStatusType findCartForCustomerWithEnhancements(Customer customer,
 ExtensionResultHolder erh)

Description copied from interface: OrderServiceExtensionHandler

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

Specified by:

findCartForCustomerWithEnhancements in interface OrderServiceExtensionHandler

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

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

Description copied from interface: OrderServiceExtensionHandler

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.

Specified by:

findCartForCustomerWithEnhancements in interface OrderServiceExtensionHandler

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