Package com.commercetools.api.models.shipping_method

Interface ShippingMethodPagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<ShippingMethod>

public interface ShippingMethodPagedQueryResponse
extends ResourcePagedQueryResponse<ShippingMethod>

PagedQueryResult with results containing an array of ShippingMethod.

Example to create an instance using the builder pattern

     ShippingMethodPagedQueryResponse shippingMethodPagedQueryResponse = ShippingMethodPagedQueryResponse.builder()
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ShippingMethodPagedQueryResponseBuilder	builder()	builder factory method for ShippingMethodPagedQueryResponse
static ShippingMethodPagedQueryResponseBuilder	builder(ShippingMethodPagedQueryResponse template)	create builder for ShippingMethodPagedQueryResponse instance
ShippingMethodPagedQueryResponse	copyDeep()
static ShippingMethodPagedQueryResponse	deepCopy(ShippingMethodPagedQueryResponse template)	factory method to create a deep copy of ShippingMethodPagedQueryResponse
@NotNull Long	getCount()	Actual number of results returned.
Long	getLimit()	Number of results requested.
Long	getOffset()	Number of elements skipped.
@NotNull @Valid List<ShippingMethod>	getResults()	Shipping Methods matching the query.
Long	getTotal()	Total number of results matching the query.
static ShippingMethodPagedQueryResponse	of()	factory method
static ShippingMethodPagedQueryResponse	of(ShippingMethodPagedQueryResponse template)	factory method to create a shallow copy ShippingMethodPagedQueryResponse
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(ShippingMethod... results)	Shipping Methods matching the query.
void	setResults(List<ShippingMethod> results)	Shipping Methods matching the query.
void	setTotal(Long total)	Total number of results matching the query.
static com.fasterxml.jackson.core.type.TypeReference<ShippingMethodPagedQueryResponse>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShippingMethodPagedQueryResponse(Function<ShippingMethodPagedQueryResponse,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.ResourcePagedQueryResponse

getPageIndex, getTotalPages, head, isFirst, isLast

Method Details

getLimit

Long getLimit()

Number of results requested.

Specified by:

getLimit in interface ResourcePagedQueryResponse<ShippingMethod>

Returns:

limit

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<ShippingMethod>

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

Returns:

total

getOffset

Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<ShippingMethod>

Returns:

offset

getResults

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

Shipping Methods matching the query.

Specified by:

getResults in interface ResourcePagedQueryResponse<ShippingMethod>

Returns:

results

setLimit

void setLimit(Long limit)

Number of results requested.

Parameters:

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

setOffset

void setOffset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

setResults

void setResults(ShippingMethod... results)

Shipping Methods matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<ShippingMethod> results)

Shipping Methods matching the query.

Parameters:

results - values to be set

of

static ShippingMethodPagedQueryResponse of()

factory method

Returns:

instance of ShippingMethodPagedQueryResponse

of

static ShippingMethodPagedQueryResponse of(ShippingMethodPagedQueryResponse template)

factory method to create a shallow copy ShippingMethodPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ShippingMethodPagedQueryResponse copyDeep()

deepCopy

@Nullable
static ShippingMethodPagedQueryResponse deepCopy(@Nullable
 ShippingMethodPagedQueryResponse template)

factory method to create a deep copy of ShippingMethodPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShippingMethodPagedQueryResponseBuilder builder()

builder factory method for ShippingMethodPagedQueryResponse

Returns:

builder

builder

static ShippingMethodPagedQueryResponseBuilder builder(ShippingMethodPagedQueryResponse template)

create builder for ShippingMethodPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShippingMethodPagedQueryResponse

default <T> T withShippingMethodPagedQueryResponse(Function<ShippingMethodPagedQueryResponse,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<ShippingMethodPagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference