Package com.broadleafcommerce.search.customer.web.endpoint

Class CustomerSearchEndpoint

java.lang.Object
com.broadleafcommerce.search.customer.web.endpoint.CustomerSearchEndpoint
@FrameworkRestController @FrameworkMapping("/customer-search") @DataRouteByKey("search") public class CustomerSearchEndpoint extends Object
Search operation for customers

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    BASE_URI
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CustomerSearchEndpoint(com.broadleafcommerce.search.core.service.SearchService<? extends com.broadleafcommerce.search.api.domain.SearchResponse> searchService, com.broadleafcommerce.search.core.service.TypeAheadService typeAheadService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected com.broadleafcommerce.search.core.service.SearchService<? extends com.broadleafcommerce.search.api.domain.SearchResponse>
    getSearchService()
     
    protected com.broadleafcommerce.search.core.service.TypeAheadService
    getTypeAheadService()
     
    protected com.broadleafcommerce.common.extension.TypeFactory
    getTypeFactory()
     
    com.broadleafcommerce.search.api.domain.SearchResponse
    search(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, org.springframework.data.domain.Pageable page, String rsqlFilter, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • CustomerSearchEndpoint

      public CustomerSearchEndpoint(com.broadleafcommerce.search.core.service.SearchService<? extends com.broadleafcommerce.search.api.domain.SearchResponse> searchService, com.broadleafcommerce.search.core.service.TypeAheadService typeAheadService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

  • Method Details

    • search

      @FrameworkGetMapping @Policy(permissionRoots="CUSTOMER") public com.broadleafcommerce.search.api.domain.SearchResponse search(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, @PageableDefault(size=50) org.springframework.data.domain.Pageable page, @RequestParam(name="cq",required=false) String rsqlFilter, @ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) throws com.broadleafcommerce.search.api.SearchException, com.broadleafcommerce.search.api.InvalidSearchException
      Throws:
      com.broadleafcommerce.search.api.SearchException
      com.broadleafcommerce.search.api.InvalidSearchException

    • getSearchService

      protected com.broadleafcommerce.search.core.service.SearchService<? extends com.broadleafcommerce.search.api.domain.SearchResponse> getSearchService()

    • getTypeAheadService

      protected com.broadleafcommerce.search.core.service.TypeAheadService getTypeAheadService()

    • getTypeFactory

      protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()