PagedResult (Composable Commerce JVM SDK 2.17.0-SNAPSHOT API)

All Known Subinterfaces:

PagedQueryResult<T>, PagedSearchResult<T>

All Known Implementing Classes:

PagedQueryResultDsl, PagedResultBase
```
public interface PagedResult<T>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`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.
`default Long`	`getPageIndex()` Calculates the page number of the result, the pages are indexed staring 0, which means that `getPageIndex()` returns a value in [0,n) , given 'n' is the total number of pages
`List<T>`	`getResults()` List of results.
`Long`	`getTotal()` The total number of results matching the request.
`default Long`	`getTotalPages()` Calculates the total number of pages matching the request.
`default Optional<T>`	`head()` Tries to access the first element of the result list.
`default boolean`	`isFirst()` Checks if this is the first page of a result.
`default boolean`	`isLast()` Checks if it is the last possible page.
`Long`	`size()` Deprecated. use `getCount()` instead

- Method Detail
  - getOffset
```
Long getOffset()
```
    The offset supplied by the client or the server default.
    
    Returns:
    
    the amount of items (not pages) skipped
  - getLimit
```
Long getLimit()
```
    The limit supplied by the client or the server default.
    
    Returns:
    
    the maximum amount of items allowed to be included in the results
  - size
```
@Deprecated
Long size()
```
    Deprecated. use getCount() instead
    
    The actual number of results returned.
    
    Returns:
    
    the number of elements in this container
  - getCount
```
Long getCount()
```
    The actual number of results returned.
    
    Returns:
    
    the number of elements in this container
  - getTotal
```
Long getTotal()
```
    The total number of results matching the request. Total is greater or equal to count.
    
    Returns:
    
    the number of elements that can be fetched matching the criteria
  - getResults
```
List<T> getResults()
```
    List of results. If getCount() is not equal to getTotal() the container contains only a subset of all elements that match the request.
    
    Returns:
    
    getCount() elements matching the request
  - head
```
default Optional<T> head()
```
    Tries to access the first element of the result list. Use case: query by slug which should contain zero or one element in the result list.
    
    Returns:
    
    the first value or absent
  - getPageIndex
```
default Long getPageIndex()
```
    Calculates the page number of the result, the pages are indexed staring 0, which means that getPageIndex() returns a value in [0,n) , given 'n' is the total number of pages
    
    Returns:
    
    the page number of the result
  - getTotalPages
```
default Long getTotalPages()
```
    Calculates the total number of pages matching the request.
    
    Returns:
    
    the total number of pages
  - isFirst
```
default boolean isFirst()
```
    Checks if this is the first page of a result.
    
    Returns:
    
    true if offset is 0 otherwise false
  - isLast
```
default boolean isLast()
```
    Checks if it is the last possible page.
    
    Returns:
    
    true if doing a request with an incremented offset parameter would cause an empty result otherwise false.

Interface PagedResult<T>

Method Summary

Method Detail

getOffset

getLimit

size

getCount

getTotal

getResults

head

getPageIndex

getTotalPages

isFirst

isLast