org.broadleafcommerce.openadmin.server.service.persistence

Interface FetchTypeDetection

public interface FetchTypeDetection

Detect the type of fetch and paging being used for a particular admin pipeline fetch request

Also, shouldPromptForSearch(PersistencePackage, CriteriaTransferObject) designates whether this fetch request should be considered empty and instead prompt the user to enter a search term in the listgrid before retrieving records. This save a wasted default retrieval delay, which could be impactful.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
FetchType	getFetchType(PersistencePackage persistencePackage, CriteriaTransferObject cto) Detect whether or not this list grid will fetch records using infinite scroll and traditional paging (FetchType.DEFAULT), or next and previous page links with scrolling only for the current page of records (FetchType.LARGERESULTSET).
boolean	shouldPromptForSearch(PersistencePackage persistencePackage, CriteriaTransferObject cto) Designates whether this fetch request should be considered empty and instead prompt the user to enter a search term in the listgrid before retrieving records.

Method Detail

getFetchType

FetchType getFetchType(PersistencePackage persistencePackage,
                       CriteriaTransferObject cto)

Detect whether or not this list grid will fetch records using infinite scroll and traditional paging (FetchType.DEFAULT), or next and previous page links with scrolling only for the current page of records (FetchType.LARGERESULTSET).

Parameters:

persistencePackage -

cto -

Returns:

shouldPromptForSearch

boolean shouldPromptForSearch(PersistencePackage persistencePackage,
                              CriteriaTransferObject cto)

Designates whether this fetch request should be considered empty and instead prompt the user to enter a search term in the listgrid before retrieving records. This save a wasted default retrieval delay, which could be impactful.

This should not include filtered list grids, as a filtered list grid indicates a search has been performed, in which case, you always want to return the records found.

Parameters:

persistencePackage -

cto -

Returns: