Package com.commercetools.api.models.order_edit

Interface OrderEditPagedQueryResponse

All Superinterfaces:
ResourcePagedQueryResponse<OrderEdit>
public interface OrderEditPagedQueryResponse extends ResourcePagedQueryResponse<OrderEdit>

PagedQueryResult with results containing an array of OrderEdit.

Example to create an instance using the builder pattern 

     OrderEditPagedQueryResponse orderEditPagedQueryResponse = OrderEditPagedQueryResponse.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.

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

    • getOffset

      @NotNull @NotNull Long getOffset()

      Number of elements skipped.

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

    • getCount

      @NotNull @NotNull Long getCount()

      Actual number of results returned.

      Specified by:
      getCount in interface ResourcePagedQueryResponse<OrderEdit>
      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<OrderEdit>
      Returns:
      total

    • getResults

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

      OrderEdits matching the query.

      Specified by:
      getResults in interface ResourcePagedQueryResponse<OrderEdit>
      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(OrderEdit... results)

      OrderEdits matching the query.

      Parameters:
      results - values to be set

    • setResults

      void setResults(List<OrderEdit> results)

      OrderEdits matching the query.

      Parameters:
      results - values to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderEditPagedQueryResponseBuilder builder()
      builder factory method for OrderEditPagedQueryResponse
      Returns:
      builder

    • builder

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

    • withOrderEditPagedQueryResponse

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