Package com.commercetools.api.models.order

Class OrderSearchRequestBuilder

java.lang.Object

com.commercetools.api.models.order.OrderSearchRequestBuilder

All Implemented Interfaces:

Builder<OrderSearchRequest>

public class OrderSearchRequestBuilder
extends Object
implements Builder<OrderSearchRequest>

OrderSearchRequestBuilder Example to create an instance using the builder pattern

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

Constructor Summary

Constructors

Constructor	Description
OrderSearchRequestBuilder()

Method Summary

Modifier and Type	Method	Description
OrderSearchRequestBuilder	addSort(Function<OrderSearchSortingBuilder,OrderSearchSorting> builder)	Controls how results to your query are sorted.
OrderSearchRequest	build()	builds OrderSearchRequest with checking for non-null required values
OrderSearchRequest	buildUnchecked()	builds OrderSearchRequest without checking for non-null required values
Integer	getLimit()	The maximum number of search results to be returned on one page.
Integer	getOffset()	The number of search results to be skipped in the response for pagination.
OrderSearchQuery	getQuery()	The Order search query.
List<OrderSearchSorting>	getSort()	Controls how results to your query are sorted.
OrderSearchRequestBuilder	limit(Integer limit)	The maximum number of search results to be returned on one page.
static OrderSearchRequestBuilder	of()	factory method for an instance of OrderSearchRequestBuilder
static OrderSearchRequestBuilder	of(OrderSearchRequest template)	create builder for OrderSearchRequest instance
OrderSearchRequestBuilder	offset(Integer offset)	The number of search results to be skipped in the response for pagination.
OrderSearchRequestBuilder	plusSort(OrderSearchSorting... sort)	Controls how results to your query are sorted.
OrderSearchRequestBuilder	plusSort(Function<OrderSearchSortingBuilder,OrderSearchSortingBuilder> builder)	Controls how results to your query are sorted.
OrderSearchRequestBuilder	query(OrderSearchQuery query)	The Order search query.
OrderSearchRequestBuilder	query(Function<OrderSearchQueryBuilder,OrderSearchQueryBuilder> builder)	The Order search query.
OrderSearchRequestBuilder	setSort(Function<OrderSearchSortingBuilder,OrderSearchSorting> builder)	Controls how results to your query are sorted.
OrderSearchRequestBuilder	sort(OrderSearchSorting... sort)	Controls how results to your query are sorted.
OrderSearchRequestBuilder	sort(List<OrderSearchSorting> sort)	Controls how results to your query are sorted.
OrderSearchRequestBuilder	withQuery(Function<OrderSearchQueryBuilder,OrderSearchQuery> builder)	The Order search query.
OrderSearchRequestBuilder	withSort(Function<OrderSearchSortingBuilder,OrderSearchSortingBuilder> builder)	Controls how results to your query are sorted.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OrderSearchRequestBuilder

public OrderSearchRequestBuilder()

Method Details

query

public OrderSearchRequestBuilder query(Function<OrderSearchQueryBuilder,OrderSearchQueryBuilder> builder)

The Order search query.

Parameters:

builder - function to build the query value

Returns:

Builder

withQuery

public OrderSearchRequestBuilder withQuery(Function<OrderSearchQueryBuilder,OrderSearchQuery> builder)

The Order search query.

Parameters:

builder - function to build the query value

Returns:

Builder

query

public OrderSearchRequestBuilder query(OrderSearchQuery query)

The Order search query.

Parameters:

query - value to be set

Returns:

Builder

sort

public OrderSearchRequestBuilder sort(@Nullable
 OrderSearchSorting... sort)

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

Parameters:

sort - value to be set

Returns:

Builder

sort

public OrderSearchRequestBuilder sort(@Nullable
 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 - value to be set

Returns:

Builder

plusSort

public OrderSearchRequestBuilder plusSort(@Nullable
 OrderSearchSorting... sort)

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

Parameters:

sort - value to be set

Returns:

Builder

plusSort

public OrderSearchRequestBuilder plusSort(Function<OrderSearchSortingBuilder,OrderSearchSortingBuilder> builder)

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

Parameters:

builder - function to build the sort value

Returns:

Builder

withSort

public OrderSearchRequestBuilder withSort(Function<OrderSearchSortingBuilder,OrderSearchSortingBuilder> builder)

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

Parameters:

builder - function to build the sort value

Returns:

Builder

addSort

public OrderSearchRequestBuilder addSort(Function<OrderSearchSortingBuilder,OrderSearchSorting> builder)

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

Parameters:

builder - function to build the sort value

Returns:

Builder

setSort

public OrderSearchRequestBuilder setSort(Function<OrderSearchSortingBuilder,OrderSearchSorting> builder)

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

Parameters:

builder - function to build the sort value

Returns:

Builder

limit

public OrderSearchRequestBuilder limit(@Nullable
 Integer limit)

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

Parameters:

limit - value to be set

Returns:

Builder

offset

public OrderSearchRequestBuilder offset(@Nullable
 Integer offset)

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

Parameters:

offset - value to be set

Returns:

Builder

getQuery

public OrderSearchQuery getQuery()

The Order search query.

Returns:

query

getSort

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

@Nullable
public Integer getLimit()

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

Returns:

limit

getOffset

@Nullable
public Integer getOffset()

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

Returns:

offset

build

public OrderSearchRequest build()

builds OrderSearchRequest with checking for non-null required values

Specified by:

build in interface Builder<OrderSearchRequest>

Returns:

OrderSearchRequest

buildUnchecked

public OrderSearchRequest buildUnchecked()

builds OrderSearchRequest without checking for non-null required values

Returns:

OrderSearchRequest

of

public static OrderSearchRequestBuilder of()

factory method for an instance of OrderSearchRequestBuilder

Returns:

builder

of

public static OrderSearchRequestBuilder of(OrderSearchRequest template)

create builder for OrderSearchRequest instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder