Interface OrderFulfillmentHydrationService

  • All Known Implementing Classes:
    DefaultOrderFulfillmentHydrationService

    public interface OrderFulfillmentHydrationService
    Service to provide optional hook points for hydrating order fulfillment views with associated entities.

    The default implementation of this service does not perform any hydration.

    Author:
    mariestandeven
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.springframework.data.domain.Page<OrderFulfillmentView> hydrate​(org.springframework.data.domain.Page<OrderFulfillmentView> orderFulfillmentViews, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Hook point to hydrate entities fetched from the internal search endpoint.
    • Method Detail

      • hydrate

        org.springframework.data.domain.Page<OrderFulfillmentView> hydrate​(org.springframework.data.domain.Page<OrderFulfillmentView> orderFulfillmentViews,
                                                                           @Nullable
                                                                           com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
        Hook point to hydrate entities fetched from the internal search endpoint. See OrderFulfillmentViewEndpoint.readAllOrderFulfillmentViews(HttpServletRequest, ContextInfo, String, boolean, Pageable, Node)

        By default, the internal search does not require hydration since the displayed fields exist on the OrderFulfillmentView. However, this method can be overridden to hydrate and display fields from sub-entities.

        Parameters:
        orderFulfillmentViews - the page of order fulfillment views to hydrate
        context - context information around sandbox and multitenant state
        Returns:
        The page of hydrated order fulfillment views