Package com.commercetools.api.models.order

Interface OrderPagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<Order>

All Known Implementing Classes:

OrderPagedQueryResponseImpl

public interface OrderPagedQueryResponse
extends ResourcePagedQueryResponse<Order>

OrderPagedQueryResponse Example to create an instance using the builder pattern

     OrderPagedQueryResponse orderPagedQueryResponse = OrderPagedQueryResponse.builder()
             .limit(0.3)
             .count(0.3)
             .offset(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static OrderPagedQueryResponseBuilder	builder()	builder factory method for OrderPagedQueryResponse
static OrderPagedQueryResponseBuilder	builder(OrderPagedQueryResponse template)	create builder for OrderPagedQueryResponse instance
static OrderPagedQueryResponse	deepCopy(OrderPagedQueryResponse template)	factory method to create a deep copy of OrderPagedQueryResponse
@NotNull Long	getCount()
@NotNull Long	getLimit()	Number of results requested.
@NotNull Long	getOffset()	Number of elements skipped.
@NotNull @Valid List<Order>	getResults()
Long	getTotal()
static OrderPagedQueryResponse	of()	factory method
static OrderPagedQueryResponse	of(OrderPagedQueryResponse template)	factory method to create a shallow copy OrderPagedQueryResponse
void	setCount(Long count)	set count
void	setLimit(Long limit)	Number of results requested.
void	setOffset(Long offset)	Number of elements skipped.
void	setResults(Order... results)	set results
void	setResults(List<Order> results)	set results
void	setTotal(Long total)	set total
static com.fasterxml.jackson.core.type.TypeReference<OrderPagedQueryResponse>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderPagedQueryResponse(Function<OrderPagedQueryResponse,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<Order>

Returns:

limit

getCount

@NotNull
@NotNull Long getCount()

Specified by:

getCount in interface ResourcePagedQueryResponse<Order>

Returns:

count

getTotal

Long getTotal()

Specified by:

getTotal in interface ResourcePagedQueryResponse<Order>

Returns:

total

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<Order>

Returns:

offset

getResults

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

Specified by:

getResults in interface ResourcePagedQueryResponse<Order>

Returns:

results

setLimit

void setLimit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

setCount

void setCount(Long count)

set count

Parameters:

count - value to be set

setTotal

void setTotal(Long total)

set total

Parameters:

total - value to be set

setOffset

void setOffset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

setResults

void setResults(Order... results)

set results

Parameters:

results - values to be set

setResults

void setResults(List<Order> results)

set results

Parameters:

results - values to be set

of

static OrderPagedQueryResponse of()

factory method

Returns:

instance of OrderPagedQueryResponse

of

static OrderPagedQueryResponse of(OrderPagedQueryResponse template)

factory method to create a shallow copy OrderPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderPagedQueryResponse deepCopy(@Nullable
 OrderPagedQueryResponse template)

factory method to create a deep copy of OrderPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderPagedQueryResponseBuilder builder()

builder factory method for OrderPagedQueryResponse

Returns:

builder

builder

static OrderPagedQueryResponseBuilder builder(OrderPagedQueryResponse template)

create builder for OrderPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderPagedQueryResponse

default <T> T withOrderPagedQueryResponse(Function<OrderPagedQueryResponse,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<OrderPagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference