|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
PageProvider
instead
@Deprecated public interface PagedDocumentsProvider
Interface that provide means to access a result set by pages, allowing easy navigation between them.
Field Summary | |
---|---|
static int |
UNKNOWN_SIZE
Deprecated. Constant to express that the total number of result elements is unknown. |
Method Summary | |
---|---|
DocumentModelList |
getCurrentPage()
Deprecated. Returns the current page of results. |
int |
getCurrentPageIndex()
Deprecated. Get current page index as a 0 (zero) based int. |
int |
getCurrentPageOffset()
Deprecated. |
int |
getCurrentPageSize()
Deprecated. |
String |
getCurrentPageStatus()
Deprecated. |
String |
getName()
Deprecated. |
DocumentModelList |
getNextPage()
Deprecated. Get the next page of documents. |
int |
getNumberOfPages()
Deprecated. Return the total number of pages |
DocumentModelList |
getPage(int page)
Deprecated. Sets the current page of results to the required one and return it. |
int |
getPageSize()
Deprecated. |
long |
getResultsCount()
Deprecated. |
SortInfo |
getSortInfo()
Deprecated. |
boolean |
isNextPageAvailable()
Deprecated. |
boolean |
isPreviousPageAvailable()
Deprecated. |
boolean |
isSortable()
Deprecated. |
void |
last()
Deprecated. Go to the last page |
void |
next()
Deprecated. Go to the next page |
void |
previous()
Deprecated. Go to the previous page |
void |
refresh()
Deprecated. Forces refresh of the current page. |
void |
rewind()
Deprecated. Go to the first page |
void |
setName(String name)
Deprecated. |
Field Detail |
---|
static final int UNKNOWN_SIZE
Method Detail |
---|
DocumentModelList getCurrentPage()
This method is designed to be called from JSF. It therefore ensures cheapness of repeated calls, rather than data consistency. There is a refresh() method for that.
DocumentModelList getPage(int page)
page
- the page index, starting from 0void refresh()
boolean isNextPageAvailable()
boolean isPreviousPageAvailable()
int getCurrentPageSize()
int getPageSize()
int getCurrentPageOffset()
UNKNOWN_SIZE
DocumentModelList getNextPage()
Has the side effect of setting the current page, too, hence
provider.getNextPage()
is equivalent to
provider.next(); page = provider.getCurrentPage()
in
terms of returned value and state of the provider, although
implementation details might imply a performance difference.
long getResultsCount()
UNKNOWN_SIZE
if it is unknownint getCurrentPageIndex()
int getNumberOfPages()
String getCurrentPageStatus()
void rewind()
void previous()
void next()
void last()
SortInfo getSortInfo()
boolean isSortable()
String getName()
void setName(String name)
name
- the provider identifier
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |