Package com.commercetools.api.models.business_unit_search

Class BusinessUnitSearchRequestBuilder

java.lang.Object

com.commercetools.api.models.business_unit_search.BusinessUnitSearchRequestBuilder

All Implemented Interfaces:

Builder<BusinessUnitSearchRequest>

public class BusinessUnitSearchRequestBuilder
extends Object
implements Builder<BusinessUnitSearchRequest>

BusinessUnitSearchRequestBuilder Example to create an instance using the builder pattern

     BusinessUnitSearchRequest businessUnitSearchRequest = BusinessUnitSearchRequest.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
BusinessUnitSearchRequestBuilder()

Method Summary

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

BusinessUnitSearchRequestBuilder

public BusinessUnitSearchRequestBuilder()

Method Details

query

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

The Business Unit Search query.

Parameters:

builder - function to build the query value

Returns:

Builder

withQuery

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

The Business Unit Search query.

Parameters:

builder - function to build the query value

Returns:

Builder

query

public BusinessUnitSearchRequestBuilder query(@Nullable
 SearchQuery query)

The Business Unit Search query.

Parameters:

query - value to be set

Returns:

Builder

sort

public BusinessUnitSearchRequestBuilder 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 BusinessUnitSearchRequestBuilder 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 BusinessUnitSearchRequestBuilder 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 BusinessUnitSearchRequestBuilder 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 BusinessUnitSearchRequestBuilder 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 BusinessUnitSearchRequestBuilder 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 BusinessUnitSearchRequestBuilder 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 BusinessUnitSearchRequestBuilder limit(@Nullable
 Integer limit)

The maximum number of search results to be returned.

Parameters:

limit - value to be set

Returns:

Builder

offset

public BusinessUnitSearchRequestBuilder 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 Business Unit 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 BusinessUnitSearchRequest build()

builds BusinessUnitSearchRequest with checking for non-null required values

Specified by:

build in interface Builder<BusinessUnitSearchRequest>

Returns:

BusinessUnitSearchRequest

buildUnchecked

public BusinessUnitSearchRequest buildUnchecked()

builds BusinessUnitSearchRequest without checking for non-null required values

Returns:

BusinessUnitSearchRequest

of

public static BusinessUnitSearchRequestBuilder of()

factory method for an instance of BusinessUnitSearchRequestBuilder

Returns:

builder

of

public static BusinessUnitSearchRequestBuilder of(BusinessUnitSearchRequest template)

create builder for BusinessUnitSearchRequest instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder