Package com.broadleafcommerce.bulkoperations.service.provider

Interface SearchProvider<I extends CatalogItem>

Type Parameters:
I - The type of the results expected in the SearchResponse. Should extend CatalogItem.
All Known Implementing Classes:
ExternalSearchProvider
public interface SearchProvider<I extends CatalogItem>
Provider for interfacing with operations around catalog search. Typically utilizes WebClient to make requests to an external REST API.

  • Method Summary

    Modifier and Type
    Method
    Description
    SearchResponse<I>
    getSearchResults(com.broadleafcommerce.bulk.v2.domain.BulkOperationRequest request, com.broadleafcommerce.bulk.v2.domain.BulkOperationResponse bulkOperationResponse, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Performs a search for the provided request.

  • Method Details

    • getSearchResults

      SearchResponse<I> getSearchResults(com.broadleafcommerce.bulk.v2.domain.BulkOperationRequest request, com.broadleafcommerce.bulk.v2.domain.BulkOperationResponse bulkOperationResponse, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Performs a search for the provided request.
      Parameters:
      request - All of the relevant information to be used to retrieve search results.
      Returns:
      The SearchResponse with results for the request.
      Throws:
      ProviderApiException - if the provider encounters an error with the request.