Package com.broadleafcommerce.customer.service.hydration

Class DefaultCustomerHydrationService

java.lang.Object

com.broadleafcommerce.customer.service.hydration.DefaultCustomerHydrationService

All Implemented Interfaces:

CustomerHydrationService

public class DefaultCustomerHydrationService
extends Object
implements CustomerHydrationService

Constructor Summary

Constructors

Constructor	Description
DefaultCustomerHydrationService()

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCustomerHydrationService

public DefaultCustomerHydrationService()

Method Detail

hydrate

public org.springframework.data.domain.Page<Customer> hydrate(org.springframework.data.domain.Page<Customer> customers,
                                                              @Nullable
                                                              com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Description copied from interface: CustomerHydrationService

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.

Specified by:

hydrate in interface CustomerHydrationService

Parameters:

customers - the page of customers to hydrate

context - context information around sandbox and multitenant state

Returns:

The page of hydrated customers