PaginableEntity (Nuxeo Java Client 3.2.0 API)

java.lang.Object
- org.nuxeo.client.objects.Entity
- - org.nuxeo.client.objects.PaginableEntity<E>

Type Parameters:

E - The underlying entity type.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Audit, Documents, Groups, Users
```
public class PaginableEntity<E>
extends Entity
```
Paginable entity is meant for entity using paginable mechanism.

Since:

3.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`currentPageIndex`
`protected int`	`currentPageSize`
`protected List<E>`	`entries`
`protected String`	`errorMessage`
`protected Boolean`	`hasError`
`protected Boolean`	`isLastPageAvailable`
`protected Boolean`	`isNextPageAvailable`
`protected Boolean`	`isPaginable`
`protected Boolean`	`isPreviousPageAvailable`
`protected Boolean`	`isSortable`
`protected int`	`maxPageSize`
`protected int`	`numberOfPages`
`protected int`	`pageCount`
`protected int`	`pageIndex`
`protected int`	`pageSize`
`protected int`	`resultsCount`
`protected int`	`totalSize`

Fields inherited from class org.nuxeo.client.objects.Entity
entityType

Constructor Summary

Constructors
Constructor and Description

PaginableEntity(String entityType)

Constructors
Constructor and Description
`PaginableEntity(String entityType)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCurrentPageIndex()`
`int`	`getCurrentPageSize()`
`List<E>`	`getEntries()`
`E`	`getEntry(int index)`
`String`	`getErrorMessage()`
`int`	`getMaxPageSize()`
`int`	`getNumberOfPages()`
`int`	`getPageCount()`
`int`	`getPageIndex()`
`int`	`getPageSize()`
`int`	`getResultsCount()`
`int`	`getTotalSize()`
`boolean`	`hasError()`
`boolean`	`isLastPageAvailable()`
`boolean`	`isNextPageAvailable()`
`boolean`	`isPaginable()`
`boolean`	`isPreviousPageAvailable()`
`boolean`	`isSortable()`
`static boolean`	`isTrue(Boolean bool)`
`int`	`size()`
`Stream<E>`	`streamEntries()`

Methods inherited from class org.nuxeo.client.objects.Entity
getEntityType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

entries
```
protected List<E> entries
```

resultsCount
```
protected int resultsCount
```

pageSize
```
protected int pageSize
```

maxPageSize
```
protected int maxPageSize
```

currentPageSize
```
protected int currentPageSize
```

currentPageIndex
```
protected int currentPageIndex
```

numberOfPages
```
protected int numberOfPages
```

totalSize
```
protected int totalSize
```

pageIndex
```
protected int pageIndex
```

pageCount
```
protected int pageCount
```

isPaginable
```
protected Boolean isPaginable
```

isPreviousPageAvailable

protected Boolean isPreviousPageAvailable

isNextPageAvailable
```
protected Boolean isNextPageAvailable
```

isLastPageAvailable
```
protected Boolean isLastPageAvailable
```

isSortable
```
protected Boolean isSortable
```

hasError
```
protected Boolean hasError
```

errorMessage
```
protected String errorMessage
```

Constructor Detail

PaginableEntity

public PaginableEntity(String entityType)

Method Detail

getEntries
```
public List<E> getEntries()
```

streamEntries
```
public Stream<E> streamEntries()
```

getEntry
```
public E getEntry(int index)
```

size
```
public int size()
```

getResultsCount
```
public int getResultsCount()
```

getPageSize
```
public int getPageSize()
```

getMaxPageSize
```
public int getMaxPageSize()
```

getCurrentPageSize
```
public int getCurrentPageSize()
```

getCurrentPageIndex
```
public int getCurrentPageIndex()
```

getNumberOfPages
```
public int getNumberOfPages()
```

getTotalSize
```
public int getTotalSize()
```

getPageIndex
```
public int getPageIndex()
```

getPageCount
```
public int getPageCount()
```

isPaginable
```
public boolean isPaginable()
```

isPreviousPageAvailable

public boolean isPreviousPageAvailable()

isNextPageAvailable
```
public boolean isNextPageAvailable()
```

isLastPageAvailable
```
public boolean isLastPageAvailable()
```

isSortable
```
public boolean isSortable()
```

hasError
```
public boolean hasError()
```

getErrorMessage
```
public String getErrorMessage()
```

isTrue

public static boolean isTrue(Boolean bool)

Class PaginableEntity<E>

Field Summary

Fields inherited from class org.nuxeo.client.objects.Entity

Constructor Summary

Method Summary

Methods inherited from class org.nuxeo.client.objects.Entity

Methods inherited from class java.lang.Object

Field Detail

entries

resultsCount

pageSize

maxPageSize

currentPageSize

currentPageIndex

numberOfPages

totalSize

pageIndex

pageCount

isPaginable

isPreviousPageAvailable

isNextPageAvailable

isLastPageAvailable

isSortable

hasError

errorMessage

Constructor Detail

PaginableEntity

Method Detail

getEntries

streamEntries

getEntry

size

getResultsCount

getPageSize

getMaxPageSize

getCurrentPageSize

getCurrentPageIndex

getNumberOfPages

getTotalSize

getPageIndex

getPageCount

isPaginable

isPreviousPageAvailable

isNextPageAvailable

isLastPageAvailable

isSortable

hasError

getErrorMessage

isTrue