Package com.commercetools.api.models.message

Interface MessagePagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<Message>

All Known Implementing Classes:

MessagePagedQueryResponseImpl

public interface MessagePagedQueryResponse
extends ResourcePagedQueryResponse<Message>

PagedQueryResult with results containing an array of Message.

Example to create an instance using the builder pattern

     MessagePagedQueryResponse messagePagedQueryResponse = MessagePagedQueryResponse.builder()
             .limit(0.3)
             .count(0.3)
             .offset(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

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

Returns:

limit

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<Message>

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

Returns:

total

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<Message>

Returns:

offset

getResults

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

Messages matching the query.

Specified by:

getResults in interface ResourcePagedQueryResponse<Message>

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

Messages matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<Message> results)

Messages matching the query.

Parameters:

results - values to be set

of

static MessagePagedQueryResponse of()

factory method

Returns:

instance of MessagePagedQueryResponse

of

static MessagePagedQueryResponse of(MessagePagedQueryResponse template)

factory method to create a shallow copy MessagePagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MessagePagedQueryResponse deepCopy(@Nullable
 MessagePagedQueryResponse template)

factory method to create a deep copy of MessagePagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MessagePagedQueryResponseBuilder builder()

builder factory method for MessagePagedQueryResponse

Returns:

builder

builder

static MessagePagedQueryResponseBuilder builder(MessagePagedQueryResponse template)

create builder for MessagePagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMessagePagedQueryResponse

default <T> T withMessagePagedQueryResponse(Function<MessagePagedQueryResponse,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<MessagePagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference