Package com.broadleafcommerce.search.provider

Interface SearchProvider<Q,R>

Type Parameters:
Q - The query object to send to the search engine
R - The query response received from the search engine
public interface SearchProvider<Q,R>
Generic interface for searching on a particular index, such as Solr.

  • Method Summary

    Modifier and Type
    Method
    Description
    R
    search(Q query, IndexableType indexableType)
    Execute a search for the provided requested implementation-specific query and type.
    R
    search(Q query, String collection)
    Execute a search for the provided requested implementation-specific query and the collection.

  • Method Details

    • search

      R search(Q query, IndexableType indexableType) throws SearchException
      Execute a search for the provided requested implementation-specific query and type.
      Parameters:
      query - The query to search by
      indexableType - The indexable type to search for
      Returns:
      Response from search engine
      Throws:
      SearchException - if an error occurs during search

    • search

      R search(Q query, String collection) throws SearchException
      Execute a search for the provided requested implementation-specific query and the collection.
      Parameters:
      query - The query to search by
      collection - The collection to perform the search on.
      Returns:
      Response from search engine
      Throws:
      SearchException - if an error occurs during search