Package com.commercetools.api.models.order

Class OrderPagedQueryResponseBuilder

java.lang.Object
com.commercetools.api.models.order.OrderPagedQueryResponseBuilder
All Implemented Interfaces:
Builder<OrderPagedQueryResponse>
public class OrderPagedQueryResponseBuilder extends Object implements Builder<OrderPagedQueryResponse>
OrderPagedQueryResponseBuilder
Example to create an instance using the builder pattern 

     OrderPagedQueryResponse orderPagedQueryResponse = OrderPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Constructor Details

    • OrderPagedQueryResponseBuilder

      public OrderPagedQueryResponseBuilder()

  • Method Details

    • limit

      public OrderPagedQueryResponseBuilder limit(Long limit)

      Number of results requested.

      Parameters:
      limit - value to be set
      Returns:
      Builder

    • offset

      public OrderPagedQueryResponseBuilder offset(Long offset)

      Number of elements skipped.

      Parameters:
      offset - value to be set
      Returns:
      Builder

    • count

      public OrderPagedQueryResponseBuilder count(Long count)

      Actual number of results returned.

      Parameters:
      count - value to be set
      Returns:
      Builder

    • total

      public OrderPagedQueryResponseBuilder total(@Nullable 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
      Returns:
      Builder

    • results

      public OrderPagedQueryResponseBuilder results(Order... results)

      Orders matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • results

      public OrderPagedQueryResponseBuilder results(List<Order> results)

      Orders matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • plusResults

      public OrderPagedQueryResponseBuilder plusResults(Order... results)

      Orders matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • plusResults

      public OrderPagedQueryResponseBuilder plusResults(Function<OrderBuilder,OrderBuilder> builder)

      Orders matching the query.

      Parameters:
      builder - function to build the results value
      Returns:
      Builder

    • withResults

      public OrderPagedQueryResponseBuilder withResults(Function<OrderBuilder,OrderBuilder> builder)

      Orders matching the query.

      Parameters:
      builder - function to build the results value
      Returns:
      Builder

    • addResults

      public OrderPagedQueryResponseBuilder addResults(Function<OrderBuilder,Order> builder)

      Orders matching the query.

      Parameters:
      builder - function to build the results value
      Returns:
      Builder

    • setResults

      public OrderPagedQueryResponseBuilder setResults(Function<OrderBuilder,Order> builder)

      Orders matching the query.

      Parameters:
      builder - function to build the results value
      Returns:
      Builder

    • getLimit

      public Long getLimit()

      Number of results requested.

      Returns:
      limit

    • getOffset

      public Long getOffset()

      Number of elements skipped.

      Returns:
      offset

    • getCount

      public Long getCount()

      Actual number of results returned.

      Returns:
      count

    • getTotal

      @Nullable public 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

      public List<Order> getResults()

      Orders matching the query.

      Returns:
      results

    • build

      public OrderPagedQueryResponse build()
      builds OrderPagedQueryResponse with checking for non-null required values
      Specified by:
      build in interface Builder<OrderPagedQueryResponse>
      Returns:
      OrderPagedQueryResponse

    • buildUnchecked

      public OrderPagedQueryResponse buildUnchecked()
      builds OrderPagedQueryResponse without checking for non-null required values
      Returns:
      OrderPagedQueryResponse

    • of

      public static OrderPagedQueryResponseBuilder of()
      factory method for an instance of OrderPagedQueryResponseBuilder
      Returns:
      builder

    • of

      public static OrderPagedQueryResponseBuilder of(OrderPagedQueryResponse template)
      create builder for OrderPagedQueryResponse instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder