io.sphere.sdk.queries

Interface PagedQueryResult<T>

Type Parameters:

T - the type of the underlying model, like category or product.

All Superinterfaces:

PagedResult<T>

All Known Implementing Classes:

PagedQueryResultDsl

public interface PagedQueryResult<T>
extends PagedResult<T>

A container for query responses which contains a subset of the matching values.

Method Summary

Modifier and Type	Method and Description
static <T> PagedQueryResultDsl<T>	empty() Creates a PagedQueryResult for queries with no matching values.
Long	getCount() The actual number of results returned.
Long	getLimit() The limit supplied by the client or the server default.
Long	getOffset() The offset supplied by the client or the server default.
List<T>	getResults() List of results.
Long	getTotal() The total number of results matching the request.
static <T> PagedQueryResultDsl<T>	of(List<T> results) Deprecated. PagedQueryResult should remain as a read model, and be constructed only by deserialization.
static <T> PagedQueryResultDsl<T>	of(Long offset, Long total, List<T> results) Deprecated. PagedQueryResult should remain as a read model, and be constructed only by deserialization.
static <T> PagedQueryResultDsl<T>	of(Long offset, Long limit, Long total, List<T> results) Deprecated. PagedQueryResult should remain as a read model, and be constructed only by deserialization.
static <T> PagedQueryResultDsl<T>	of(T singleResult) Deprecated. PagedQueryResult should remain as a read model, and be constructed only by deserialization.

Methods inherited from interface io.sphere.sdk.queries.PagedResult

getPageIndex, getTotalPages, head, isFirst, isLast, size

Method Detail

empty

static <T> PagedQueryResultDsl<T> empty()

Creates a PagedQueryResult for queries with no matching values.

Type Parameters:

T - the type of the underlying model

Returns:

an empty PagedQueryResult

of

@Deprecated
static <T> PagedQueryResultDsl<T> of(Long offset,
                                                 Long limit,
                                                 Long total,
                                                 List<T> results)

Deprecated. PagedQueryResult should remain as a read model, and be constructed only by deserialization.

Type Parameters:

T - the type of the underlying model

Parameters:

limit - The limit supplied by the client or the server default

offset - The offset supplied by the client or the server default.

total - The total number of results matching the request.

results - the mocked results.

Returns:

the paged query result.

of

@Deprecated
static <T> PagedQueryResultDsl<T> of(Long offset,
                                                 Long total,
                                                 List<T> results)

Deprecated. PagedQueryResult should remain as a read model, and be constructed only by deserialization.

Type Parameters:

T - the type of the underlying model

Parameters:

offset - The offset supplied by the client or the server default.

total - The total number of results matching the request.

results - The mocked result.

Returns:

the paged query result.

of

@Deprecated
static <T> PagedQueryResultDsl<T> of(List<T> results)

Deprecated. PagedQueryResult should remain as a read model, and be constructed only by deserialization.

Type Parameters:

T - the type of the underlying model

Parameters:

results - The mocked result.

Returns:

the paged query result.

of

static <T> PagedQueryResultDsl<T> of(T singleResult)

Deprecated. PagedQueryResult should remain as a read model, and be constructed only by deserialization.

Type Parameters:

T - the type of the underlying model

Parameters:

singleResult - the single result expected in the return.

Returns:

the paged query result.

getCount

Long getCount()

The actual number of results returned.

Specified by:

getCount in interface PagedResult<T>

Returns:

the number of elements in this container

getOffset

Long getOffset()

The offset supplied by the client or the server default.

Specified by:

getOffset in interface PagedResult<T>

Returns:

the amount of items (not pages) skipped

getLimit

Long getLimit()

The limit supplied by the client or the server default.

Specified by:

getLimit in interface PagedResult<T>

Returns:

the maximum amount of items allowed to be included in the results

getResults

List<T> getResults()

List of results. If PagedResult.getCount() is not equal to PagedResult.getTotal() the container contains only a subset of all elements that match the request.

Specified by:

getResults in interface PagedResult<T>

Returns:

PagedResult.getCount() elements matching the request

getTotal

Long getTotal()

The total number of results matching the request. Total is greater or equal to count.

Specified by:

getTotal in interface PagedResult<T>

Returns:

the number of elements that can be fetched matching the criteria