Package com.broadleafcommerce.search.core.service

Interface SearchService<T>

  • Type Parameters:
    T - The API response
    All Known Implementing Classes:
    DefaultSearchService
    public interface SearchService<T>
    Generic search service, returning a specific type, T

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      T search​(com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Perform a search for the provided requested query and page.

    • Method Detail

      • search

        T search​(com.broadleafcommerce.search.api.domain.SearchRequest searchRequest,
         org.springframework.data.domain.Pageable page,
         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
  throws com.broadleafcommerce.search.api.SearchException,
         com.broadleafcommerce.search.api.InvalidSearchException
        Perform a search for the provided requested query and page.
        Parameters:
        searchRequest - The query information to search by
        page - The page to retrieve
        contextInfo - The context information surrounding sandboxing/multitenant state
        Returns:
        Search results with facet and sort information
        Throws:
        com.broadleafcommerce.search.api.SearchException
        com.broadleafcommerce.search.api.InvalidSearchException