Package com.commercetools.api.models.product

Interface ProductProjectionPagedSearchResponse

All Superinterfaces:
ResourcePagedQueryResponse<ProductProjection>
public interface ProductProjectionPagedSearchResponse extends ResourcePagedQueryResponse<ProductProjection>

The response returned to a Product Projection Search request. The object contains the query results with Product Projections where at least one ProductVariant matches the search query, as well as the facet results, if requested.

Example to create an instance using the builder pattern 

     ProductProjectionPagedSearchResponse productProjectionPagedSearchResponse = ProductProjectionPagedSearchResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Method Details

    • getLimit

      @NotNull @NotNull Long getLimit()

      The maximum number of results returned on a page.

      Specified by:
      getLimit in interface ResourcePagedQueryResponse<ProductProjection>
      Returns:
      limit

    • getOffset

      @NotNull @NotNull Long getOffset()

      The starting point for the retrieved paginated result.

      Specified by:
      getOffset in interface ResourcePagedQueryResponse<ProductProjection>
      Returns:
      offset

    • getCount

      @NotNull @NotNull Long getCount()

      Actual number of results returned.

      Specified by:
      getCount in interface ResourcePagedQueryResponse<ProductProjection>
      Returns:
      count

    • getTotal

      Long getTotal()

      Total number of results matching the query.

      Specified by:
      getTotal in interface ResourcePagedQueryResponse<ProductProjection>
      Returns:
      total

    • getResults

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

      ProductProjections where at least one ProductVariant matches the search query, provided with the text.{language} and/or filter.query or filter query parameter. If the query parameter markMatchingVariants=true was provided with the request, the matching variants are marked as such.

      Specified by:
      getResults in interface ResourcePagedQueryResponse<ProductProjection>
      Returns:
      results

    • getFacets

      @Valid @Valid FacetResults getFacets()

      Facet results for each facet expression specified in the search request.

      Only present if at least one facet parameter was provided with the search request.

      Returns:
      facets

    • setLimit

      void setLimit(Long limit)

      The maximum number of results returned on a page.

      Parameters:
      limit - value to be set

    • setOffset

      void setOffset(Long offset)

      The starting point for the retrieved paginated result.

      Parameters:
      offset - value to be set

    • setCount

      void setCount(Long count)

      Actual number of results returned.

      Parameters:
      count - value to be set

    • setTotal

      void setTotal(Long total)

      Total number of results matching the query.

      Parameters:
      total - value to be set

    • setResults

      void setResults(ProductProjection... results)

      ProductProjections where at least one ProductVariant matches the search query, provided with the text.{language} and/or filter.query or filter query parameter. If the query parameter markMatchingVariants=true was provided with the request, the matching variants are marked as such.

      Parameters:
      results - values to be set

    • setResults

      void setResults(List<ProductProjection> results)

      ProductProjections where at least one ProductVariant matches the search query, provided with the text.{language} and/or filter.query or filter query parameter. If the query parameter markMatchingVariants=true was provided with the request, the matching variants are marked as such.

      Parameters:
      results - values to be set

    • setFacets

      void setFacets(FacetResults facets)

      Facet results for each facet expression specified in the search request.

      Only present if at least one facet parameter was provided with the search request.

      Parameters:
      facets - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ProductProjectionPagedSearchResponseBuilder builder()
      builder factory method for ProductProjectionPagedSearchResponse
      Returns:
      builder

    • builder

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

    • withProductProjectionPagedSearchResponse

      default <T> T withProductProjectionPagedSearchResponse(Function<ProductProjectionPagedSearchResponse,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<ProductProjectionPagedSearchResponse> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference