Page (Cyclos 4.14.14 Scripting API Documentation)

Type Parameters:

T - The data type

All Superinterfaces:

Iterable<T>

All Known Implementing Classes:

PageImpl
```
public interface Page<T>
extends Iterable<T>
```
A page contains a subset of data, and knows the number of total results

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CURRENT_PAGE`
`static int`	`DEFAULT_PAGE_SIZE`
`static String`	`HAS_NEXT_PAGE`
`static String`	`PAGE_COUNT`
`static String`	`PAGE_ITEMS`
`static String`	`PAGE_SIZE`
`static String`	`TOTAL_COUNT`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getCurrentPage()`	Returns the number of this page within the total
`Integer`	`getPageCount()`	Returns the total number of pages.
`List<T>`	`getPageItems()`	Returns the page items
`int`	`getPageSize()`	Returns the page size
`Integer`	`getTotalCount()`	Returns the total number of records.
`boolean`	`isHasNextPage()`	Returns whether a next page exists
`Stream<T>`	`stream()`	Returns a stream with the page items

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Field Detail
  - DEFAULT_PAGE_SIZE
```
static final int DEFAULT_PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - CURRENT_PAGE
```
static final String CURRENT_PAGE
```
    See Also:
    
    Constant Field Values
  - HAS_NEXT_PAGE
```
static final String HAS_NEXT_PAGE
```
    See Also:
    
    Constant Field Values
  - PAGE_COUNT
```
static final String PAGE_COUNT
```
    See Also:
    
    Constant Field Values
  - PAGE_ITEMS
```
static final String PAGE_ITEMS
```
    See Also:
    
    Constant Field Values
  - PAGE_SIZE
```
static final String PAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - TOTAL_COUNT
```
static final String TOTAL_COUNT
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getCurrentPage
```
int getCurrentPage()
```
    Returns the number of this page within the total
  - getPageCount
```
Integer getPageCount()
```
    Returns the total number of pages. If the total count is unknown, returns null.
  - getPageItems
```
List<T> getPageItems()
```
    Returns the page items
  - getPageSize
```
int getPageSize()
```
    Returns the page size
  - getTotalCount
```
Integer getTotalCount()
```
    Returns the total number of records. If the total count is unknown, returns null.
  - isHasNextPage
```
boolean isHasNextPage()
```
    Returns whether a next page exists
  - stream
```
Stream<T> stream()
```
    Returns a stream with the page items