Interface CustomerHydrationService

  • All Known Implementing Classes:
    DefaultCustomerHydrationService

    public interface CustomerHydrationService
    Service to provide optional hook points for hydrating customers 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<Customer> hydrate​(org.springframework.data.domain.Page<Customer> customers, 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<Customer> hydrate​(org.springframework.data.domain.Page<Customer> customers,
                                                               @Nullable
                                                               com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
        Hook point to hydrate entities fetched from the internal search endpoint. See CustomerEndpoint.readAllCustomers(ContextInfo, String, boolean, Node, Pageable).

        By default, the internal search does not require hydration since the displayed fields exist on the Customer entity. However, this method can be overridden to hydrate and display fields from related entities, e.g. Account.

        Parameters:
        customers - the page of customers to hydrate
        context - context information around sandbox and multitenant state
        Returns:
        The page of hydrated customers