Package com.commercetools.api.models.product_selection

Interface ProductSelectionPagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<ProductSelection>

All Known Implementing Classes:

ProductSelectionPagedQueryResponseImpl

public interface ProductSelectionPagedQueryResponse
extends ResourcePagedQueryResponse<ProductSelection>

PagedQueryResult containing an array of ProductSelection.

Example to create an instance using the builder pattern

     ProductSelectionPagedQueryResponse productSelectionPagedQueryResponse = ProductSelectionPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

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

Returns:

limit

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<ProductSelection>

Returns:

offset

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<ProductSelection>

Returns:

count

getTotal

Long getTotal()

Total number of results matching the query. This number is an estimation that is not strongly consistent. Unlike other endpoints, the Product Selection endpoint does not return this field by default. To get total, pass the query parameter withTotal set to true. When the results are filtered with a Query Predicate, total is subject to a limit.

Specified by:

getTotal in interface ResourcePagedQueryResponse<ProductSelection>

Returns:

total

getResults

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

ProductSelections matching the query.

Specified by:

getResults in interface ResourcePagedQueryResponse<ProductSelection>

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. Unlike other endpoints, the Product Selection endpoint does not return this field by default. To get total, pass the query parameter withTotal set to true. When the results are filtered with a Query Predicate, total is subject to a limit.

Parameters:

total - value to be set

setResults

void setResults(ProductSelection... results)

ProductSelections matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<ProductSelection> results)

ProductSelections matching the query.

Parameters:

results - values to be set

of

static ProductSelectionPagedQueryResponse of()

factory method

Returns:

instance of ProductSelectionPagedQueryResponse

of

static ProductSelectionPagedQueryResponse of(ProductSelectionPagedQueryResponse template)

factory method to create a shallow copy ProductSelectionPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductSelectionPagedQueryResponse deepCopy(@Nullable
 ProductSelectionPagedQueryResponse template)

factory method to create a deep copy of ProductSelectionPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductSelectionPagedQueryResponseBuilder builder()

builder factory method for ProductSelectionPagedQueryResponse

Returns:

builder

builder

static ProductSelectionPagedQueryResponseBuilder builder(ProductSelectionPagedQueryResponse template)

create builder for ProductSelectionPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductSelectionPagedQueryResponse

default <T> T withProductSelectionPagedQueryResponse(Function<ProductSelectionPagedQueryResponse,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<ProductSelectionPagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference