Package com.commercetools.api.models.business_unit

Interface BusinessUnitPagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<BusinessUnit>

All Known Implementing Classes:

BusinessUnitPagedQueryResponseImpl

public interface BusinessUnitPagedQueryResponse
extends ResourcePagedQueryResponse<BusinessUnit>

PagedQueryResult with results containing an array of BusinessUnit.

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

Method Summary

Modifier and Type	Method	Description
static BusinessUnitPagedQueryResponseBuilder	builder()	builder factory method for BusinessUnitPagedQueryResponse
static BusinessUnitPagedQueryResponseBuilder	builder(BusinessUnitPagedQueryResponse template)	create builder for BusinessUnitPagedQueryResponse instance
static BusinessUnitPagedQueryResponse	deepCopy(BusinessUnitPagedQueryResponse template)	factory method to create a deep copy of BusinessUnitPagedQueryResponse
@NotNull Long	getCount()	Actual number of results returned.
@NotNull Long	getLimit()	Number of requested results.
@NotNull Long	getOffset()	Number of elements skipped.
@NotNull @Valid List<BusinessUnit>	getResults()	BusinessUnits matching the query.
Long	getTotal()	Total number of results matching the query.
static BusinessUnitPagedQueryResponse	of()	factory method
static BusinessUnitPagedQueryResponse	of(BusinessUnitPagedQueryResponse template)	factory method to create a shallow copy BusinessUnitPagedQueryResponse
void	setCount(Long count)	Actual number of results returned.
void	setLimit(Long limit)	Number of requested results.
void	setOffset(Long offset)	Number of elements skipped.
void	setResults(BusinessUnit... results)	BusinessUnits matching the query.
void	setResults(List<BusinessUnit> results)	BusinessUnits matching the query.
void	setTotal(Long total)	Total number of results matching the query.
static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitPagedQueryResponse>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBusinessUnitPagedQueryResponse(Function<BusinessUnitPagedQueryResponse,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.ResourcePagedQueryResponse

getPageIndex, getTotalPages, head, isFirst, isLast

Method Details

getLimit

@NotNull
@NotNull Long getLimit()

Number of requested results.

Specified by:

getLimit in interface ResourcePagedQueryResponse<BusinessUnit>

Returns:

limit

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<BusinessUnit>

Returns:

offset

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<BusinessUnit>

Returns:

count

getTotal

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.

Specified by:

getTotal in interface ResourcePagedQueryResponse<BusinessUnit>

Returns:

total

getResults

@NotNull
@Valid
@NotNull @Valid List<BusinessUnit> getResults()

BusinessUnits matching the query.

Specified by:

getResults in interface ResourcePagedQueryResponse<BusinessUnit>

Returns:

results

setLimit

void setLimit(Long limit)

Number of requested results.

Parameters:

limit - value to be set

setOffset

void setOffset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

setCount

void setCount(Long count)

Actual number of results returned.

Parameters:

count - value to be set

setTotal

void setTotal(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

setResults

void setResults(BusinessUnit... results)

BusinessUnits matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<BusinessUnit> results)

BusinessUnits matching the query.

Parameters:

results - values to be set

of

static BusinessUnitPagedQueryResponse of()

factory method

Returns:

instance of BusinessUnitPagedQueryResponse

of

static BusinessUnitPagedQueryResponse of(BusinessUnitPagedQueryResponse template)

factory method to create a shallow copy BusinessUnitPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitPagedQueryResponse deepCopy(@Nullable
 BusinessUnitPagedQueryResponse template)

factory method to create a deep copy of BusinessUnitPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitPagedQueryResponseBuilder builder()

builder factory method for BusinessUnitPagedQueryResponse

Returns:

builder

builder

static BusinessUnitPagedQueryResponseBuilder builder(BusinessUnitPagedQueryResponse template)

create builder for BusinessUnitPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitPagedQueryResponse

default <T> T withBusinessUnitPagedQueryResponse(Function<BusinessUnitPagedQueryResponse,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<BusinessUnitPagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference