Package com.commercetools.api.models.order

Interface OrderSearchRequest

public interface OrderSearchRequest
OrderSearchRequest
Example to create an instance using the builder pattern 

     OrderSearchRequest orderSearchRequest = OrderSearchRequest.builder()
             .query(queryBuilder -> queryBuilder)
             .build()

  • Method Details

    • getQuery

      @NotNull @Valid @NotNull @Valid OrderSearchQuery getQuery()

      The Order search query.

      Returns:
      query

    • getSort

      @Valid @Valid List<OrderSearchSorting> getSort()

      Controls how results to your query are sorted. If not provided, the results are sorted by relevance in descending order.

      Returns:
      sort

    • getLimit

      Integer getLimit()

      The maximum number of search results to be returned on one page.

      Returns:
      limit

    • getOffset

      Integer getOffset()

      The number of search results to be skipped in the response for pagination.

      Returns:
      offset

    • setQuery

      void setQuery(OrderSearchQuery query)

      The Order search query.

      Parameters:
      query - value to be set

    • setSort

      void setSort(OrderSearchSorting... sort)

      Controls how results to your query are sorted. If not provided, the results are sorted by relevance in descending order.

      Parameters:
      sort - values to be set

    • setSort

      void setSort(List<OrderSearchSorting> sort)

      Controls how results to your query are sorted. If not provided, the results are sorted by relevance in descending order.

      Parameters:
      sort - values to be set

    • setLimit

      void setLimit(Integer limit)

      The maximum number of search results to be returned on one page.

      Parameters:
      limit - value to be set

    • setOffset

      void setOffset(Integer offset)

      The number of search results to be skipped in the response for pagination.

      Parameters:
      offset - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderSearchRequestBuilder builder()
      builder factory method for OrderSearchRequest
      Returns:
      builder

    • builder

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

    • withOrderSearchRequest

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