Package com.commercetools.api.models.business_unit

Class BusinessUnitPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.business_unit.BusinessUnitPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<BusinessUnitPagedQueryResponse>

public class BusinessUnitPagedQueryResponseBuilder
extends Object
implements Builder<BusinessUnitPagedQueryResponse>

BusinessUnitPagedQueryResponseBuilder Example to create an instance using the builder pattern

     BusinessUnitPagedQueryResponse businessUnitPagedQueryResponse = BusinessUnitPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
BusinessUnitPagedQueryResponseBuilder()

Method Summary

Modifier and Type	Method	Description
BusinessUnitPagedQueryResponse	build()	builds BusinessUnitPagedQueryResponse with checking for non-null required values
BusinessUnitPagedQueryResponse	buildUnchecked()	builds BusinessUnitPagedQueryResponse without checking for non-null required values
BusinessUnitPagedQueryResponseBuilder	count(Long count)	Actual number of results returned.
Long	getCount()	Actual number of results returned.
Long	getLimit()	Number of requested results.
Long	getOffset()	Number of elements skipped.
List<BusinessUnit>	getResults()	BusinessUnits matching the query.
Long	getTotal()	Total number of results matching the query.
BusinessUnitPagedQueryResponseBuilder	limit(Long limit)	Number of requested results.
static BusinessUnitPagedQueryResponseBuilder	of()	factory method for an instance of BusinessUnitPagedQueryResponseBuilder
static BusinessUnitPagedQueryResponseBuilder	of(BusinessUnitPagedQueryResponse template)	create builder for BusinessUnitPagedQueryResponse instance
BusinessUnitPagedQueryResponseBuilder	offset(Long offset)	Number of elements skipped.
BusinessUnitPagedQueryResponseBuilder	plusResults(BusinessUnit... results)	BusinessUnits matching the query.
BusinessUnitPagedQueryResponseBuilder	plusResults(Function<BusinessUnitBuilder,Builder<? extends BusinessUnit>> builder)	BusinessUnits matching the query.
BusinessUnitPagedQueryResponseBuilder	results(BusinessUnit... results)	BusinessUnits matching the query.
BusinessUnitPagedQueryResponseBuilder	results(List<BusinessUnit> results)	BusinessUnits matching the query.
BusinessUnitPagedQueryResponseBuilder	total(Long total)	Total number of results matching the query.
BusinessUnitPagedQueryResponseBuilder	withResults(Function<BusinessUnitBuilder,Builder<? extends BusinessUnit>> builder)	BusinessUnits matching the query.

Methods inherited from class java.lang.Object

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

Constructor Details

BusinessUnitPagedQueryResponseBuilder

public BusinessUnitPagedQueryResponseBuilder()

Method Details

limit

public BusinessUnitPagedQueryResponseBuilder limit(Long limit)

Number of requested results.

Parameters:

limit - value to be set

Returns:

Builder

offset

public BusinessUnitPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public BusinessUnitPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public BusinessUnitPagedQueryResponseBuilder 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 BusinessUnitPagedQueryResponseBuilder results(BusinessUnit... results)

BusinessUnits matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public BusinessUnitPagedQueryResponseBuilder results(List<BusinessUnit> results)

BusinessUnits matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public BusinessUnitPagedQueryResponseBuilder plusResults(BusinessUnit... results)

BusinessUnits matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public BusinessUnitPagedQueryResponseBuilder plusResults(Function<BusinessUnitBuilder,Builder<? extends BusinessUnit>> builder)

BusinessUnits matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public BusinessUnitPagedQueryResponseBuilder withResults(Function<BusinessUnitBuilder,Builder<? extends BusinessUnit>> builder)

BusinessUnits matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

getLimit

public Long getLimit()

Number of requested results.

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<BusinessUnit> getResults()

BusinessUnits matching the query.

Returns:

results

build

public BusinessUnitPagedQueryResponse build()

builds BusinessUnitPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<BusinessUnitPagedQueryResponse>

Returns:

BusinessUnitPagedQueryResponse

buildUnchecked

public BusinessUnitPagedQueryResponse buildUnchecked()

builds BusinessUnitPagedQueryResponse without checking for non-null required values

Returns:

BusinessUnitPagedQueryResponse

of

public static BusinessUnitPagedQueryResponseBuilder of()

factory method for an instance of BusinessUnitPagedQueryResponseBuilder

Returns:

builder

of

public static BusinessUnitPagedQueryResponseBuilder of(BusinessUnitPagedQueryResponse template)

create builder for BusinessUnitPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder