Package com.commercetools.api.models.discount_group

Interface DiscountGroupPagedQueryResponse

public interface DiscountGroupPagedQueryResponse

PagedQueryResult with results containing an array of DiscountGroup.

Example to create an instance using the builder pattern 

     DiscountGroupPagedQueryResponse discountGroupPagedQueryResponse = DiscountGroupPagedQueryResponse.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. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

      Returns:
      total

    • getResults

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

      DiscountGroups 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. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

      Parameters:
      total - value to be set

    • setResults

      void setResults(DiscountGroup... results)

      DiscountGroups matching the query.

      Parameters:
      results - values to be set

    • setResults

      void setResults(List<DiscountGroup> results)

      DiscountGroups matching the query.

      Parameters:
      results - values to be set

    • of

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

    • of

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

    • copyDeep

      DiscountGroupPagedQueryResponse copyDeep()

    • deepCopy

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

    • builder

      static DiscountGroupPagedQueryResponseBuilder builder()
      builder factory method for DiscountGroupPagedQueryResponse
      Returns:
      builder

    • builder

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

    • withDiscountGroupPagedQueryResponse

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