Package com.commercetools.api.models.product_search

Interface ProductPagedSearchResponse

public interface ProductPagedSearchResponse
ProductPagedSearchResponse
Example to create an instance using the builder pattern 

     ProductPagedSearchResponse productPagedSearchResponse = ProductPagedSearchResponse.builder()
             .total(0.3)
             .offset(0.3)
             .limit(0.3)
             .plusFacets(facetsBuilder -> facetsBuilder)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Method Details

    • getTotal

      @NotNull @NotNull Long getTotal()

      Total number of results matching the query.

      Returns:
      total

    • getOffset

      @NotNull @NotNull Integer getOffset()

      Number of elements skipped.

      Returns:
      offset

    • getLimit

      @NotNull @NotNull Integer getLimit()

      Number of results requested.

      Returns:
      limit

    • getFacets

      @NotNull @Valid @NotNull @Valid List<ProductSearchFacetResult> getFacets()

      Results for facets when requested.

      Returns:
      facets

    • getResults

      @NotNull @Valid @NotNull @Valid List<ProductSearchResult> getResults()

      Search result containing the Products matching the search query.

      Returns:
      results

    • setTotal

      void setTotal(Long total)

      Total number of results matching the query.

      Parameters:
      total - value to be set

    • setOffset

      void setOffset(Integer offset)

      Number of elements skipped.

      Parameters:
      offset - value to be set

    • setLimit

      void setLimit(Integer limit)

      Number of results requested.

      Parameters:
      limit - value to be set

    • setFacets

      void setFacets(ProductSearchFacetResult... facets)

      Results for facets when requested.

      Parameters:
      facets - values to be set

    • setFacets

      void setFacets(List<ProductSearchFacetResult> facets)

      Results for facets when requested.

      Parameters:
      facets - values to be set

    • setResults

      void setResults(ProductSearchResult... results)

      Search result containing the Products matching the search query.

      Parameters:
      results - values to be set

    • setResults

      void setResults(List<ProductSearchResult> results)

      Search result containing the Products matching the search query.

      Parameters:
      results - values to be set

    • of

      static ProductPagedSearchResponse of()
      factory method
      Returns:
      instance of ProductPagedSearchResponse

    • of

      static ProductPagedSearchResponse of(ProductPagedSearchResponse template)
      factory method to create a shallow copy ProductPagedSearchResponse
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ProductPagedSearchResponse copyDeep()

    • deepCopy

      @Nullable static ProductPagedSearchResponse deepCopy(@Nullable ProductPagedSearchResponse template)
      factory method to create a deep copy of ProductPagedSearchResponse
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ProductPagedSearchResponseBuilder builder()
      builder factory method for ProductPagedSearchResponse
      Returns:
      builder

    • builder

      static ProductPagedSearchResponseBuilder builder(ProductPagedSearchResponse template)
      create builder for ProductPagedSearchResponse instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withProductPagedSearchResponse

      default <T> T withProductPagedSearchResponse(Function<ProductPagedSearchResponse,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ProductPagedSearchResponse> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference