Package com.broadleafcommerce.search.core.service

Interface TypeAheadService

  • public interface TypeAheadService
    Service interface for retrieving TypeAhead suggestions.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse getSuggestions​(com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Returns suggestions based on the request.
      com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse getSuggestions​(com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest request, SearchRequestProperties properties, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Returns suggestions based on the request.

    • Method Detail

      • getSuggestions

        com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse getSuggestions​(com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest request,
                                                                                   @Nullable
                                                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
                                                                            throws com.broadleafcommerce.search.api.SearchException
        Returns suggestions based on the request.
        Parameters:
        request - The TypeAheadRequest
        context - The context information surrounding sandboxing/multitenant state
        Returns:
        A TypeAheadResponse with suggestions.
        Throws:
        com.broadleafcommerce.search.api.SearchException

      • getSuggestions

        com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse getSuggestions​(com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest request,
                                                                                   SearchRequestProperties properties,
                                                                                   @Nullable
                                                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
                                                                            throws com.broadleafcommerce.search.api.SearchException
        Returns suggestions based on the request.
        Parameters:
        request - The TypeAheadRequest
        properties - Additional properties to use on this request.
        context - The context information surrounding sandboxing/multitenant state
        Returns:
        A TypeAheadResponse with suggestions.
        Throws:
        com.broadleafcommerce.search.api.SearchException