Package com.commercetools.api.models.recurring_order

Interface RecurringOrderPagedQueryResponse

public interface RecurringOrderPagedQueryResponse

PagedQueryResult with results containing an array of RecurringOrder.

Example to create an instance using the builder pattern 

     RecurringOrderPagedQueryResponse recurringOrderPagedQueryResponse = RecurringOrderPagedQueryResponse.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<RecurringOrder> getResults()

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

      RecurringOrders matching the query.

      Parameters:
      results - values to be set

    • setResults

      void setResults(List<RecurringOrder> results)

      RecurringOrders matching the query.

      Parameters:
      results - values to be set

    • of

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

    • of

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

    • copyDeep

      RecurringOrderPagedQueryResponse copyDeep()

    • deepCopy

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

    • builder

      static RecurringOrderPagedQueryResponseBuilder builder()
      builder factory method for RecurringOrderPagedQueryResponse
      Returns:
      builder

    • builder

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

    • withRecurringOrderPagedQueryResponse

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