Package com.commercetools.api.models.product_selection

Interface AssignedProductSelectionPagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<AssignedProductSelection>

public interface AssignedProductSelectionPagedQueryResponse
extends ResourcePagedQueryResponse<AssignedProductSelection>

PagedQueryResult containing an array of AssignedProductSelection.

Example to create an instance using the builder pattern

     AssignedProductSelectionPagedQueryResponse assignedProductSelectionPagedQueryResponse = AssignedProductSelectionPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

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

Returns:

limit

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<AssignedProductSelection>

Returns:

offset

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<AssignedProductSelection>

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

Returns:

total

getResults

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

References to ProductSelection that are assigned to the Product.

Specified by:

getResults in interface ResourcePagedQueryResponse<AssignedProductSelection>

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

References to ProductSelection that are assigned to the Product.

Parameters:

results - values to be set

setResults

void setResults(List<AssignedProductSelection> results)

References to ProductSelection that are assigned to the Product.

Parameters:

results - values to be set

of

static AssignedProductSelectionPagedQueryResponse of()

factory method

Returns:

instance of AssignedProductSelectionPagedQueryResponse

of

static AssignedProductSelectionPagedQueryResponse of(AssignedProductSelectionPagedQueryResponse template)

factory method to create a shallow copy AssignedProductSelectionPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AssignedProductSelectionPagedQueryResponse deepCopy(@Nullable
 AssignedProductSelectionPagedQueryResponse template)

factory method to create a deep copy of AssignedProductSelectionPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AssignedProductSelectionPagedQueryResponseBuilder builder()

builder factory method for AssignedProductSelectionPagedQueryResponse

Returns:

builder

builder

static AssignedProductSelectionPagedQueryResponseBuilder builder(AssignedProductSelectionPagedQueryResponse template)

create builder for AssignedProductSelectionPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAssignedProductSelectionPagedQueryResponse

default <T> T withAssignedProductSelectionPagedQueryResponse(Function<AssignedProductSelectionPagedQueryResponse,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<AssignedProductSelectionPagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference