Package org.craftercms.studio.api.v2.service.search

Interface SearchService

All Known Implementing Classes:
ClausesLimitAwareSearchService, SearchServiceImpl, SearchServiceInternalImpl
public interface SearchService
Provides access to OpenSearch for authoring indexes
Author:
joseross

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_MAX_EXPANSIONS
    The default maximum number of terms for fuzzy queries expands to.

  • Method Summary

    Modifier and Type
    Method
    Description
    default SearchResult
    search(String siteId, SearchParams params)
    Performs a search operation for a given site
    SearchResult
    search(String siteId, SearchParams params, int maxExpansions)
    Performs a search operation for a given site

  • Field Details

    • DEFAULT_MAX_EXPANSIONS

      static final int DEFAULT_MAX_EXPANSIONS
      The default maximum number of terms for fuzzy queries expands to.
      See Also:

  • Method Details

    • search

      SearchResult search(String siteId, SearchParams params, int maxExpansions) throws ServiceLayerException
      Performs a search operation for a given site
      Parameters:
      siteId - the id of the site
      params - the parameters for the search
      maxExpansions - Specifies the maximum number of terms for fuzzy queries expands to.
      Returns:
      the search results
      Throws:
      ServiceLayerException - if there is any error executing the search in OpenSearch

    • search

      default SearchResult search(String siteId, SearchParams params) throws ServiceLayerException
      Performs a search operation for a given site
      Parameters:
      siteId - the id of the site
      params - the parameters for the search
      Returns:
      the search results
      Throws:
      ServiceLayerException - if there is any error executing the search in OpenSearch