Package com.commercetools.api.models.product_selection

Interface ProductSelectionProductPagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<AssignedProductReference>

public interface ProductSelectionProductPagedQueryResponse
extends ResourcePagedQueryResponse<AssignedProductReference>

PagedQueryResult containing an array of AssignedProductReference.

Example to create an instance using the builder pattern

     ProductSelectionProductPagedQueryResponse productSelectionProductPagedQueryResponse = ProductSelectionProductPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

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

Returns:

limit

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<AssignedProductReference>

Returns:

offset

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<AssignedProductReference>

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

Returns:

total

getResults

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

References to Products that are assigned to the ProductSelection.

Specified by:

getResults in interface ResourcePagedQueryResponse<AssignedProductReference>

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

References to Products that are assigned to the ProductSelection.

Parameters:

results - values to be set

setResults

void setResults(List<AssignedProductReference> results)

References to Products that are assigned to the ProductSelection.

Parameters:

results - values to be set

of

static ProductSelectionProductPagedQueryResponse of()

factory method

Returns:

instance of ProductSelectionProductPagedQueryResponse

of

static ProductSelectionProductPagedQueryResponse of(ProductSelectionProductPagedQueryResponse template)

factory method to create a shallow copy ProductSelectionProductPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductSelectionProductPagedQueryResponse deepCopy(@Nullable
 ProductSelectionProductPagedQueryResponse template)

factory method to create a deep copy of ProductSelectionProductPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductSelectionProductPagedQueryResponseBuilder builder()

builder factory method for ProductSelectionProductPagedQueryResponse

Returns:

builder

builder

static ProductSelectionProductPagedQueryResponseBuilder builder(ProductSelectionProductPagedQueryResponse template)

create builder for ProductSelectionProductPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductSelectionProductPagedQueryResponse

default <T> T withProductSelectionProductPagedQueryResponse(Function<ProductSelectionProductPagedQueryResponse,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<ProductSelectionProductPagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference