Package com.broadleafcommerce.search.core.service

Interface QueryBuilder<Q>

public interface QueryBuilder<Q>

  • Method Summary

    Modifier and Type
    Method
    Description
    Q
    constructQuery(com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, org.springframework.data.domain.Pageable page, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Create the query to execute in the search engine from the provided search query request
    Q
    constructQuery(com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, org.springframework.data.domain.Pageable page, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, SearchRequestProperties properties, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Create the query to execute in the search engine from the provided search query request

  • Method Details

    • constructQuery

      Q constructQuery(com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, org.springframework.data.domain.Pageable page, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context) throws com.broadleafcommerce.search.api.SearchException
      Create the query to execute in the search engine from the provided search query request
      Parameters:
      searchRequest - The search query request
      page - Page information for page to retrieve for query
      fieldDefinitions - The Field Definitions to use when constructing the query.
      context - The context information surrounding sandboxing/multitenant state
      Returns:
      Query object to execute requested search in search engine
      Throws:
      com.broadleafcommerce.search.api.SearchException - if an error occurs building the query

    • constructQuery

      Q constructQuery(com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, org.springframework.data.domain.Pageable page, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, SearchRequestProperties properties, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Create the query to execute in the search engine from the provided search query request
      Parameters:
      searchRequest - The search query request
      page - Page information for page to retrieve for query
      fieldDefinitions - The Field Definitions to use when constructing the query.
      properties - Additional properties to use on this request.
      context - The context information surrounding sandboxing/multitenant state
      Returns:
      Query object to execute requested search in search engine