Package com.commercetools.api.models.variant

Interface VariantPagedQueryResponse

public interface VariantPagedQueryResponse

PagedQueryResult with results containing an array of Variant.

Example to create an instance using the builder pattern 

     VariantPagedQueryResponse variantPagedQueryResponse = VariantPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Method Details

    • getLimit

      @NotNull @NotNull Long getLimit()

      Number of results requested.

      Returns:
      limit

    • getOffset

      @NotNull @NotNull Long getOffset()

      Number of elements skipped.

      Returns:
      offset

    • getCount

      @NotNull @NotNull Long getCount()

      Actual number of results returned.

      Returns:
      count

    • getTotal

      Long getTotal()

      Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. Unless absolutely necessary, use the query parameter withTotal=false to improve performance by deactivating the calculation of this field. When the results are filtered with a Query Predicate, total is subject to a limit.

      Returns:
      total

    • getResults

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

      Variants matching the query.

      Returns:
      results

    • setLimit

      void setLimit(Long limit)

      Number of results requested.

      Parameters:
      limit - value to be set

    • setOffset

      void setOffset(Long offset)

      Number of elements skipped.

      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. This number is an estimation that is not strongly consistent. This field is returned by default. Unless absolutely necessary, use the query parameter withTotal=false to improve performance by deactivating the calculation of this field. When the results are filtered with a Query Predicate, total is subject to a limit.

      Parameters:
      total - value to be set

    • setResults

      void setResults(Variant... results)

      Variants matching the query.

      Parameters:
      results - values to be set

    • setResults

      void setResults(List<Variant> results)

      Variants matching the query.

      Parameters:
      results - values to be set

    • of

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

    • of

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

    • copyDeep

      VariantPagedQueryResponse copyDeep()

    • deepCopy

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

    • builder

      static VariantPagedQueryResponseBuilder builder()
      builder factory method for VariantPagedQueryResponse
      Returns:
      builder

    • builder

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

    • withVariantPagedQueryResponse

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

    • typeReference

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