Package com.commercetools.api.models.order

Interface OrderPagedSearchResponse

All Known Implementing Classes:

OrderPagedSearchResponseImpl

public interface OrderPagedSearchResponse

OrderPagedSearchResponse Example to create an instance using the builder pattern

     OrderPagedSearchResponse orderPagedSearchResponse = OrderPagedSearchResponse.builder()
             .total(0.3)
             .plusHits(hitsBuilder -> hitsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static OrderPagedSearchResponseBuilder	builder()	builder factory method for OrderPagedSearchResponse
static OrderPagedSearchResponseBuilder	builder(OrderPagedSearchResponse template)	create builder for OrderPagedSearchResponse instance
static OrderPagedSearchResponse	deepCopy(OrderPagedSearchResponse template)	factory method to create a deep copy of OrderPagedSearchResponse
@NotNull @Valid List<Hit>	getHits()	Actual results.
Long	getLimit()	Number of results requested.
Long	getOffset()	Number of elements skipped.
@NotNull Long	getTotal()	Total number of results matching the query.
static OrderPagedSearchResponse	of()	factory method
static OrderPagedSearchResponse	of(OrderPagedSearchResponse template)	factory method to create a shallow copy OrderPagedSearchResponse
void	setHits(Hit... hits)	Actual results.
void	setHits(List<Hit> hits)	Actual results.
void	setLimit(Long limit)	Number of results requested.
void	setOffset(Long offset)	Number of elements skipped.
void	setTotal(Long total)	Total number of results matching the query.
static com.fasterxml.jackson.core.type.TypeReference<OrderPagedSearchResponse>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderPagedSearchResponse(Function<OrderPagedSearchResponse,T> helper)	accessor map function

Method Details

getTotal

@NotNull
@NotNull Long getTotal()

Total number of results matching the query.

Returns:

total

getOffset

Long getOffset()

Number of elements skipped.

Returns:

offset

getLimit

Long getLimit()

Number of results requested.

Returns:

limit

getHits

@NotNull
@Valid
@NotNull @Valid List<Hit> getHits()

Actual results.

Returns:

hits

setTotal

void setTotal(Long total)

Total number of results matching the query.

Parameters:

total - value to be set

setOffset

void setOffset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

setLimit

void setLimit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

setHits

void setHits(Hit... hits)

Actual results.

Parameters:

hits - values to be set

setHits

void setHits(List<Hit> hits)

Actual results.

Parameters:

hits - values to be set

of

static OrderPagedSearchResponse of()

factory method

Returns:

instance of OrderPagedSearchResponse

of

static OrderPagedSearchResponse of(OrderPagedSearchResponse template)

factory method to create a shallow copy OrderPagedSearchResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderPagedSearchResponse deepCopy(@Nullable
 OrderPagedSearchResponse template)

factory method to create a deep copy of OrderPagedSearchResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderPagedSearchResponseBuilder builder()

builder factory method for OrderPagedSearchResponse

Returns:

builder

builder

static OrderPagedSearchResponseBuilder builder(OrderPagedSearchResponse template)

create builder for OrderPagedSearchResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderPagedSearchResponse

default <T> T withOrderPagedSearchResponse(Function<OrderPagedSearchResponse,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<OrderPagedSearchResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference