Package com.commercetools.api.models.product_selection

Interface ProductsInStorePagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<ProductSelectionAssignment>

public interface ProductsInStorePagedQueryResponse
extends ResourcePagedQueryResponse<ProductSelectionAssignment>

PagedQueryResult containing an array of ProductSelectionAssignment.

Example to create an instance using the builder pattern

     ProductsInStorePagedQueryResponse productsInStorePagedQueryResponse = ProductsInStorePagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

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

Returns:

limit

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<ProductSelectionAssignment>

Returns:

offset

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<ProductSelectionAssignment>

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

Returns:

total

getResults

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

ProductSelectionAssignments matching the query.

Specified by:

getResults in interface ResourcePagedQueryResponse<ProductSelectionAssignment>

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

ProductSelectionAssignments matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<ProductSelectionAssignment> results)

ProductSelectionAssignments matching the query.

Parameters:

results - values to be set

of

static ProductsInStorePagedQueryResponse of()

factory method

Returns:

instance of ProductsInStorePagedQueryResponse

of

static ProductsInStorePagedQueryResponse of(ProductsInStorePagedQueryResponse template)

factory method to create a shallow copy ProductsInStorePagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductsInStorePagedQueryResponse deepCopy(@Nullable
 ProductsInStorePagedQueryResponse template)

factory method to create a deep copy of ProductsInStorePagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductsInStorePagedQueryResponseBuilder builder()

builder factory method for ProductsInStorePagedQueryResponse

Returns:

builder

builder

static ProductsInStorePagedQueryResponseBuilder builder(ProductsInStorePagedQueryResponse template)

create builder for ProductsInStorePagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductsInStorePagedQueryResponse

default <T> T withProductsInStorePagedQueryResponse(Function<ProductsInStorePagedQueryResponse,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<ProductsInStorePagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference