Package com.commercetools.api.models.attribute_group

Interface AttributeGroupPagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<AttributeGroup>

All Known Implementing Classes:

AttributeGroupPagedQueryResponseImpl

public interface AttributeGroupPagedQueryResponse
extends ResourcePagedQueryResponse<AttributeGroup>

PagedQueryResult with results containing an array of AttributeGroup.

Example to create an instance using the builder pattern

     AttributeGroupPagedQueryResponse attributeGroupPagedQueryResponse = AttributeGroupPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static AttributeGroupPagedQueryResponseBuilder	builder()	builder factory method for AttributeGroupPagedQueryResponse
static AttributeGroupPagedQueryResponseBuilder	builder(AttributeGroupPagedQueryResponse template)	create builder for AttributeGroupPagedQueryResponse instance
static AttributeGroupPagedQueryResponse	deepCopy(AttributeGroupPagedQueryResponse template)	factory method to create a deep copy of AttributeGroupPagedQueryResponse
@NotNull Long	getCount()	Actual number of results returned.
@NotNull Long	getLimit()	Number of results requested in the query request.
@NotNull Long	getOffset()	Offset supplied by the client or the server default.
@NotNull @Valid List<AttributeGroup>	getResults()	AttributeGroups matching the query.
Long	getTotal()	Total number of results matching the query.
static AttributeGroupPagedQueryResponse	of()	factory method
static AttributeGroupPagedQueryResponse	of(AttributeGroupPagedQueryResponse template)	factory method to create a shallow copy AttributeGroupPagedQueryResponse
void	setCount(Long count)	Actual number of results returned.
void	setLimit(Long limit)	Number of results requested in the query request.
void	setOffset(Long offset)	Offset supplied by the client or the server default.
void	setResults(AttributeGroup... results)	AttributeGroups matching the query.
void	setResults(List<AttributeGroup> results)	AttributeGroups matching the query.
void	setTotal(Long total)	Total number of results matching the query.
static com.fasterxml.jackson.core.type.TypeReference<AttributeGroupPagedQueryResponse>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAttributeGroupPagedQueryResponse(Function<AttributeGroupPagedQueryResponse,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 in the query request.

Specified by:

getLimit in interface ResourcePagedQueryResponse<AttributeGroup>

Returns:

limit

getOffset

@NotNull
@NotNull Long getOffset()

Offset supplied by the client or the server default. It is the number of elements skipped, not a page number.

Specified by:

getOffset in interface ResourcePagedQueryResponse<AttributeGroup>

Returns:

offset

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<AttributeGroup>

Returns:

count

getTotal

Long getTotal()

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

Returns:

total

getResults

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

AttributeGroups matching the query.

Specified by:

getResults in interface ResourcePagedQueryResponse<AttributeGroup>

Returns:

results

setLimit

void setLimit(Long limit)

Number of results requested in the query request.

Parameters:

limit - value to be set

setOffset

void setOffset(Long offset)

Offset supplied by the client or the server default. It is the number of elements skipped, not a page number.

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

AttributeGroups matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<AttributeGroup> results)

AttributeGroups matching the query.

Parameters:

results - values to be set

of

static AttributeGroupPagedQueryResponse of()

factory method

Returns:

instance of AttributeGroupPagedQueryResponse

of

static AttributeGroupPagedQueryResponse of(AttributeGroupPagedQueryResponse template)

factory method to create a shallow copy AttributeGroupPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AttributeGroupPagedQueryResponse deepCopy(@Nullable
 AttributeGroupPagedQueryResponse template)

factory method to create a deep copy of AttributeGroupPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AttributeGroupPagedQueryResponseBuilder builder()

builder factory method for AttributeGroupPagedQueryResponse

Returns:

builder

builder

static AttributeGroupPagedQueryResponseBuilder builder(AttributeGroupPagedQueryResponse template)

create builder for AttributeGroupPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAttributeGroupPagedQueryResponse

default <T> T withAttributeGroupPagedQueryResponse(Function<AttributeGroupPagedQueryResponse,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<AttributeGroupPagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference