org.nuxeo.ecm.automation.client.model

Class PaginableDocuments

java.lang.Object

org.nuxeo.ecm.automation.client.model.Documents

org.nuxeo.ecm.automation.client.model.PaginableDocuments

All Implemented Interfaces:

Serializable, Iterable<Document>, OperationInput

public class PaginableDocuments
extends Documents

Author:

matic

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	currentPageIndex
protected int	numberOfPages
protected int	pageCount Deprecated. since 5.7.3. Use numberOfPages.
protected int	pageIndex Deprecated. since 5.7.3. Use currentPageIndex.
protected int	pageSize
protected int	resultsCount
protected int	totalSize Deprecated. since 5.7.3. Use resultsCount.

Fields inherited from class org.nuxeo.ecm.automation.client.model.Documents

docs

Constructor Summary

Constructors

Constructor and Description
PaginableDocuments()
PaginableDocuments(List<Document> docs, int resultsCount, int pageSize, int numberOfPages, int currentPageIndex)

Method Summary

Modifier and Type	Method and Description
int	getCurrentPageIndex()
int	getNumberOfPages()
int	getPageCount() Deprecated. since 5.7.3. Use getNumberOfPages().
int	getPageIndex() Deprecated. since 5.7.3. Use getCurrentPageIndex().
int	getPageSize()
int	getResultsCount()
int	getTotalSize() Deprecated. since 5.7.3. Use getResultsCount().
void	setCurrentPageIndex(int currentPageIndex)
void	setNumberOfPages(int numberOfPages)
void	setPageCount(int pageCount) Deprecated. since 5.7.3. Use setNumberOfPages(int).
void	setPageIndex(int pageIndex) Deprecated. since 5.7.3. Use setCurrentPageIndex(int).
void	setPageSize(int pageSize)
void	setResultsCount(int resultsCount)
void	setTotalSize(int totalSize) Deprecated. since 5.7.3. Use setResultsCount(int).

Methods inherited from class org.nuxeo.ecm.automation.client.model.Documents

add, dump, get, getInputRef, getInputType, isBinary, isEmpty, iterator, list, size, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

totalSize

@Deprecated
protected int totalSize

Deprecated. since 5.7.3. Use resultsCount.

pageCount

@Deprecated
protected int pageCount

Deprecated. since 5.7.3. Use numberOfPages.

pageIndex

@Deprecated
protected int pageIndex

Deprecated. since 5.7.3. Use currentPageIndex.

pageSize

protected int pageSize

currentPageIndex

protected int currentPageIndex

numberOfPages

protected int numberOfPages

resultsCount

protected int resultsCount

Constructor Detail

PaginableDocuments

public PaginableDocuments()

PaginableDocuments

public PaginableDocuments(List<Document> docs,
                          int resultsCount,
                          int pageSize,
                          int numberOfPages,
                          int currentPageIndex)

Parameters:

size -

Method Detail

getTotalSize

@Deprecated
public int getTotalSize()

Deprecated. since 5.7.3. Use getResultsCount().

getPageCount

@Deprecated
public int getPageCount()

Deprecated. since 5.7.3. Use getNumberOfPages().

getPageIndex

@Deprecated
public int getPageIndex()

Deprecated. since 5.7.3. Use getCurrentPageIndex().

setTotalSize

@Deprecated
public void setTotalSize(int totalSize)

Deprecated. since 5.7.3. Use setResultsCount(int).

setPageCount

@Deprecated
public void setPageCount(int pageCount)

Deprecated. since 5.7.3. Use setNumberOfPages(int).

setPageIndex

@Deprecated
public void setPageIndex(int pageIndex)

Deprecated. since 5.7.3. Use setCurrentPageIndex(int).

getPageSize

public int getPageSize()

setPageSize

public void setPageSize(int pageSize)

getCurrentPageIndex

public int getCurrentPageIndex()

setCurrentPageIndex

public void setCurrentPageIndex(int currentPageIndex)

getNumberOfPages

public int getNumberOfPages()

setNumberOfPages

public void setNumberOfPages(int numberOfPages)

getResultsCount

public int getResultsCount()

setResultsCount

public void setResultsCount(int resultsCount)