Package com.commercetools.api.models.api_client

Interface ApiClientPagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<ApiClient>

All Known Implementing Classes:

ApiClientPagedQueryResponseImpl

public interface ApiClientPagedQueryResponse
extends ResourcePagedQueryResponse<ApiClient>

PagedQueryResult with results containing an array of APIClient.

Example to create an instance using the builder pattern

     ApiClientPagedQueryResponse apiClientPagedQueryResponse = ApiClientPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ApiClientPagedQueryResponseBuilder	builder()	builder factory method for ApiClientPagedQueryResponse
static ApiClientPagedQueryResponseBuilder	builder(ApiClientPagedQueryResponse template)	create builder for ApiClientPagedQueryResponse instance
static ApiClientPagedQueryResponse	deepCopy(ApiClientPagedQueryResponse template)	factory method to create a deep copy of ApiClientPagedQueryResponse
@NotNull Long	getCount()	Actual number of results returned.
@NotNull Long	getLimit()	Number of results requested.
@NotNull Long	getOffset()	Number of elements skipped.
@NotNull @Valid List<ApiClient>	getResults()	APIClients matching the query.
Long	getTotal()	Total number of results matching the query.
static ApiClientPagedQueryResponse	of()	factory method
static ApiClientPagedQueryResponse	of(ApiClientPagedQueryResponse template)	factory method to create a shallow copy ApiClientPagedQueryResponse
void	setCount(Long count)	Actual number of results returned.
void	setLimit(Long limit)	Number of results requested.
void	setOffset(Long offset)	Number of elements skipped.
void	setResults(ApiClient... results)	APIClients matching the query.
void	setResults(List<ApiClient> results)	APIClients matching the query.
void	setTotal(Long total)	Total number of results matching the query.
static com.fasterxml.jackson.core.type.TypeReference<ApiClientPagedQueryResponse>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withApiClientPagedQueryResponse(Function<ApiClientPagedQueryResponse,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 results requested.

Specified by:

getLimit in interface ResourcePagedQueryResponse<ApiClient>

Returns:

limit

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<ApiClient>

Returns:

offset

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<ApiClient>

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<ApiClient>

Returns:

total

getResults

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

APIClients matching the query.

Specified by:

getResults in interface ResourcePagedQueryResponse<ApiClient>

Returns:

results

setLimit

void setLimit(Long limit)

Number of results requested.

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(ApiClient... results)

APIClients matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<ApiClient> results)

APIClients matching the query.

Parameters:

results - values to be set

of

static ApiClientPagedQueryResponse of()

factory method

Returns:

instance of ApiClientPagedQueryResponse

of

static ApiClientPagedQueryResponse of(ApiClientPagedQueryResponse template)

factory method to create a shallow copy ApiClientPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ApiClientPagedQueryResponse deepCopy(@Nullable
 ApiClientPagedQueryResponse template)

factory method to create a deep copy of ApiClientPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ApiClientPagedQueryResponseBuilder builder()

builder factory method for ApiClientPagedQueryResponse

Returns:

builder

builder

static ApiClientPagedQueryResponseBuilder builder(ApiClientPagedQueryResponse template)

create builder for ApiClientPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withApiClientPagedQueryResponse

default <T> T withApiClientPagedQueryResponse(Function<ApiClientPagedQueryResponse,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<ApiClientPagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference