Package com.commercetools.api.models.custom_object

Interface CustomObjectPagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<CustomObject>

All Known Implementing Classes:

CustomObjectPagedQueryResponseImpl

public interface CustomObjectPagedQueryResponse
extends ResourcePagedQueryResponse<CustomObject>

PagedQueryResult with results containing an array of CustomObject.

Example to create an instance using the builder pattern

     CustomObjectPagedQueryResponse customObjectPagedQueryResponse = CustomObjectPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static CustomObjectPagedQueryResponseBuilder	builder()	builder factory method for CustomObjectPagedQueryResponse
static CustomObjectPagedQueryResponseBuilder	builder(CustomObjectPagedQueryResponse template)	create builder for CustomObjectPagedQueryResponse instance
static CustomObjectPagedQueryResponse	deepCopy(CustomObjectPagedQueryResponse template)	factory method to create a deep copy of CustomObjectPagedQueryResponse
@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<CustomObject>	getResults()	CustomObjects matching the query.
Long	getTotal()	The total number of results matching the query.
static CustomObjectPagedQueryResponse	of()	factory method
static CustomObjectPagedQueryResponse	of(CustomObjectPagedQueryResponse template)	factory method to create a shallow copy CustomObjectPagedQueryResponse
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(CustomObject... results)	CustomObjects matching the query.
void	setResults(List<CustomObject> results)	CustomObjects matching the query.
void	setTotal(Long total)	The total number of results matching the query.
static com.fasterxml.jackson.core.type.TypeReference<CustomObjectPagedQueryResponse>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomObjectPagedQueryResponse(Function<CustomObjectPagedQueryResponse,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<CustomObject>

Returns:

limit

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<CustomObject>

Returns:

offset

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<CustomObject>

Returns:

count

getTotal

Long getTotal()

The 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<CustomObject>

Returns:

total

getResults

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

CustomObjects matching the query.

Specified by:

getResults in interface ResourcePagedQueryResponse<CustomObject>

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)

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

CustomObjects matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<CustomObject> results)

CustomObjects matching the query.

Parameters:

results - values to be set

of

static CustomObjectPagedQueryResponse of()

factory method

Returns:

instance of CustomObjectPagedQueryResponse

of

static CustomObjectPagedQueryResponse of(CustomObjectPagedQueryResponse template)

factory method to create a shallow copy CustomObjectPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomObjectPagedQueryResponse deepCopy(@Nullable
 CustomObjectPagedQueryResponse template)

factory method to create a deep copy of CustomObjectPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomObjectPagedQueryResponseBuilder builder()

builder factory method for CustomObjectPagedQueryResponse

Returns:

builder

builder

static CustomObjectPagedQueryResponseBuilder builder(CustomObjectPagedQueryResponse template)

create builder for CustomObjectPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomObjectPagedQueryResponse

default <T> T withCustomObjectPagedQueryResponse(Function<CustomObjectPagedQueryResponse,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<CustomObjectPagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference