Package com.commercetools.api.models.standalone_price

Interface StandalonePricePagedQueryResponse

All Superinterfaces:
ResourcePagedQueryResponse<StandalonePrice>
public interface StandalonePricePagedQueryResponse extends ResourcePagedQueryResponse<StandalonePrice>

PagedQueryResult with results containing an array of StandalonePrice.

Example to create an instance using the builder pattern 

     StandalonePricePagedQueryResponse standalonePricePagedQueryResponse = StandalonePricePagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Method Details

    • getLimit

      @NotNull @NotNull Long getLimit()

      Number of requested results.

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

    • getOffset

      @NotNull @NotNull Long getOffset()

      Offset supplied by the client or server default. It is the number of elements skipped, not a page number.

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

    • getCount

      @NotNull @NotNull Long getCount()

      Actual number of results returned.

      Specified by:
      getCount in interface ResourcePagedQueryResponse<StandalonePrice>
      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.

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

    • getResults

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

      StandalonePrices matching the query.

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

    • setLimit

      void setLimit(Long limit)

      Number of requested results.

      Parameters:
      limit - value to be set

    • setOffset

      void setOffset(Long offset)

      Offset supplied by the client or server default. It is the number of elements skipped, not a page number.

      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(StandalonePrice... results)

      StandalonePrices matching the query.

      Parameters:
      results - values to be set

    • setResults

      void setResults(List<StandalonePrice> results)

      StandalonePrices matching the query.

      Parameters:
      results - values to be set

    • of

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

    • of

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

    • copyDeep

      StandalonePricePagedQueryResponse copyDeep()

    • deepCopy

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

    • builder

      static StandalonePricePagedQueryResponseBuilder builder()
      builder factory method for StandalonePricePagedQueryResponse
      Returns:
      builder

    • builder

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

    • withStandalonePricePagedQueryResponse

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