Package org.broadleafcommerce.core.order.service

Interface OrderServiceExtensionHandler

All Superinterfaces:
org.broadleafcommerce.common.extension.ExtensionHandler
All Known Implementing Classes:
AbstractOrderServiceExtensionHandler, CartMessageOrderItemServiceExtensionHandler, OrderServiceExtensionManager
public interface OrderServiceExtensionHandler extends org.broadleafcommerce.common.extension.ExtensionHandler
Author:
Andre Azzolini (apazzolini), bpolster

  • Method Summary

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

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

    getPriority, isEnabled

  • Method Details

    • attachAdditionalDataToNewNamedCart

      org.broadleafcommerce.common.extension.ExtensionResultStatusType attachAdditionalDataToNewNamedCart(org.broadleafcommerce.profile.core.domain.Customer customer, Order cart)

    • preValidateCartOperation

      org.broadleafcommerce.common.extension.ExtensionResultStatusType preValidateCartOperation(Order cart, org.broadleafcommerce.common.extension.ExtensionResultHolder erh)

    • preValidateUpdateQuantityOperation

      org.broadleafcommerce.common.extension.ExtensionResultStatusType preValidateUpdateQuantityOperation(Order cart, OrderItemRequestDTO dto, org.broadleafcommerce.common.extension.ExtensionResultHolder erh)

    • attachAdditionalDataToOrder

      org.broadleafcommerce.common.extension.ExtensionResultStatusType attachAdditionalDataToOrder(Order order, boolean priceOrder)
      Can be used to attach or update fields must prior to saving an order.
      Returns:

    • addOfferCodes

      org.broadleafcommerce.common.extension.ExtensionResultStatusType addOfferCodes(Order order, List<OfferCode> offerCodes, boolean priceOrder)

    • findCartForCustomerWithEnhancements

      org.broadleafcommerce.common.extension.ExtensionResultStatusType findCartForCustomerWithEnhancements(org.broadleafcommerce.profile.core.domain.Customer customer, org.broadleafcommerce.common.extension.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

      org.broadleafcommerce.common.extension.ExtensionResultStatusType findCartForCustomerWithEnhancements(org.broadleafcommerce.profile.core.domain.Customer customer, Order candidateCart, org.broadleafcommerce.common.extension.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