Package com.commercetools.api.models.customer

Interface CustomerPagedQueryResponse

All Superinterfaces:

ResourcePagedQueryResponse<Customer>

All Known Implementing Classes:

CustomerPagedQueryResponseImpl

public interface CustomerPagedQueryResponse
extends ResourcePagedQueryResponse<Customer>

PagedQueryResult with results containing an array of Customer.

Example to create an instance using the builder pattern

     CustomerPagedQueryResponse customerPagedQueryResponse = CustomerPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

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

Returns:

limit

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Specified by:

getOffset in interface ResourcePagedQueryResponse<Customer>

Returns:

offset

getCount

@NotNull
@NotNull Long getCount()

Actual number of results returned.

Specified by:

getCount in interface ResourcePagedQueryResponse<Customer>

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

Returns:

total

getResults

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

Customers matching the query.

Specified by:

getResults in interface ResourcePagedQueryResponse<Customer>

Returns:

results

setLimit

void setLimit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

setOffset

void setOffset(Long offset)

Number of elements skipped.

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

Customers matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<Customer> results)

Customers matching the query.

Parameters:

results - values to be set

of

static CustomerPagedQueryResponse of()

factory method

Returns:

instance of CustomerPagedQueryResponse

of

static CustomerPagedQueryResponse of(CustomerPagedQueryResponse template)

factory method to create a shallow copy CustomerPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomerPagedQueryResponse deepCopy(@Nullable
 CustomerPagedQueryResponse template)

factory method to create a deep copy of CustomerPagedQueryResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerPagedQueryResponseBuilder builder()

builder factory method for CustomerPagedQueryResponse

Returns:

builder

builder

static CustomerPagedQueryResponseBuilder builder(CustomerPagedQueryResponse template)

create builder for CustomerPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerPagedQueryResponse

default <T> T withCustomerPagedQueryResponse(Function<CustomerPagedQueryResponse,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<CustomerPagedQueryResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference