Package com.commercetools.api.models.customer_search

Class CustomerSearchRequestBuilder

java.lang.Object

com.commercetools.api.models.customer_search.CustomerSearchRequestBuilder

All Implemented Interfaces:

Builder<CustomerSearchRequest>

public class CustomerSearchRequestBuilder
extends Object
implements Builder<CustomerSearchRequest>

CustomerSearchRequestBuilder Example to create an instance using the builder pattern

     CustomerSearchRequest customerSearchRequest = CustomerSearchRequest.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CustomerSearchRequestBuilder()

Method Summary

Modifier and Type	Method	Description
CustomerSearchRequestBuilder	addSort(Function<SearchSortingBuilder,SearchSorting> builder)	Controls how results to your query are sorted.
CustomerSearchRequest	build()	builds CustomerSearchRequest with checking for non-null required values
CustomerSearchRequest	buildUnchecked()	builds CustomerSearchRequest without checking for non-null required values
Integer	getLimit()	The maximum number of search results to be returned.
Integer	getOffset()	The number of search results to be skipped in the response for pagination.
SearchQuery	getQuery()	The Customer search query.
List<SearchSorting>	getSort()	Controls how results to your query are sorted.
CustomerSearchRequestBuilder	limit(Integer limit)	The maximum number of search results to be returned.
static CustomerSearchRequestBuilder	of()	factory method for an instance of CustomerSearchRequestBuilder
static CustomerSearchRequestBuilder	of(CustomerSearchRequest template)	create builder for CustomerSearchRequest instance
CustomerSearchRequestBuilder	offset(Integer offset)	The number of search results to be skipped in the response for pagination.
CustomerSearchRequestBuilder	plusSort(SearchSorting... sort)	Controls how results to your query are sorted.
CustomerSearchRequestBuilder	plusSort(Function<SearchSortingBuilder,SearchSortingBuilder> builder)	Controls how results to your query are sorted.
CustomerSearchRequestBuilder	query(SearchQuery query)	The Customer search query.
CustomerSearchRequestBuilder	query(Function<SearchQueryBuilder,SearchQueryBuilder> builder)	The Customer search query.
CustomerSearchRequestBuilder	setSort(Function<SearchSortingBuilder,SearchSorting> builder)	Controls how results to your query are sorted.
CustomerSearchRequestBuilder	sort(SearchSorting... sort)	Controls how results to your query are sorted.
CustomerSearchRequestBuilder	sort(List<SearchSorting> sort)	Controls how results to your query are sorted.
CustomerSearchRequestBuilder	withQuery(Function<SearchQueryBuilder,SearchQuery> builder)	The Customer search query.
CustomerSearchRequestBuilder	withSort(Function<SearchSortingBuilder,SearchSortingBuilder> 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

CustomerSearchRequestBuilder

public CustomerSearchRequestBuilder()

Method Details

query

public CustomerSearchRequestBuilder query(Function<SearchQueryBuilder,SearchQueryBuilder> builder)

The Customer search query.

Parameters:

builder - function to build the query value

Returns:

Builder

withQuery

public CustomerSearchRequestBuilder withQuery(Function<SearchQueryBuilder,SearchQuery> builder)

The Customer search query.

Parameters:

builder - function to build the query value

Returns:

Builder

query

public CustomerSearchRequestBuilder query(@Nullable
 SearchQuery query)

The Customer search query.

Parameters:

query - value to be set

Returns:

Builder

sort

public CustomerSearchRequestBuilder sort(@Nullable
 SearchSorting... 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 CustomerSearchRequestBuilder sort(@Nullable
 List<SearchSorting> 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 CustomerSearchRequestBuilder plusSort(@Nullable
 SearchSorting... 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 CustomerSearchRequestBuilder plusSort(Function<SearchSortingBuilder,SearchSortingBuilder> 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 CustomerSearchRequestBuilder withSort(Function<SearchSortingBuilder,SearchSortingBuilder> 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 CustomerSearchRequestBuilder addSort(Function<SearchSortingBuilder,SearchSorting> 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 CustomerSearchRequestBuilder setSort(Function<SearchSortingBuilder,SearchSorting> 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 CustomerSearchRequestBuilder limit(@Nullable
 Integer limit)

The maximum number of search results to be returned.

Parameters:

limit - value to be set

Returns:

Builder

offset

public CustomerSearchRequestBuilder 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

@Nullable
public SearchQuery getQuery()

The Customer search query.

Returns:

query

getSort

@Nullable
public List<SearchSorting> 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.

Returns:

limit

getOffset

@Nullable
public Integer getOffset()

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

Returns:

offset

build

public CustomerSearchRequest build()

builds CustomerSearchRequest with checking for non-null required values

Specified by:

build in interface Builder<CustomerSearchRequest>

Returns:

CustomerSearchRequest

buildUnchecked

public CustomerSearchRequest buildUnchecked()

builds CustomerSearchRequest without checking for non-null required values

Returns:

CustomerSearchRequest

of

public static CustomerSearchRequestBuilder of()

factory method for an instance of CustomerSearchRequestBuilder

Returns:

builder

of

public static CustomerSearchRequestBuilder of(CustomerSearchRequest template)

create builder for CustomerSearchRequest instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder