public class UsersPageProvider extends AbstractPageProvider<DocumentModel> implements PageProvider<DocumentModel>
This page provider requires two parameters: the first one to
be filled with the search string, and the second one to
be filled with the selected letter when using the tabbed
listing mode.
This page provider requires the property USERS_LISTING_MODE_PROPERTY
to
be filled with a the listing mode to use.
DEFAULT_MAX_PAGE_SIZE, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY
Constructor and Description |
---|
UsersPageProvider() |
Modifier and Type | Method and Description |
---|---|
Collection<String> |
getCatalogLetters() |
List<DocumentModel> |
getCurrentPage()
Returns the current page of results.
|
boolean |
isSortable()
This page provider does not support sort for now => override what may be
contributed in the definition
|
void |
refresh()
Refresh hook, to override for custom behavior
|
addSortInfo, firstPage, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasChangedParameters, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, last, lastPage, next, nextEntry, nextPage, previous, previousEntry, previousPage, rewind, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addSortInfo, firstPage, getCurrentEntry, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxPageSize, getName, getNumberOfPages, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasChangedParameters, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, lastPage, nextEntry, nextPage, previousEntry, previousPage, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos
public List<DocumentModel> getCurrentPage()
PageProvider
This method is designed to be called from higher levels. It therefore ensures cheapness of repeated calls, rather than data consistency. There is a refresh() method for that.
getCurrentPage
in interface PageProvider<DocumentModel>
getCurrentPage
in class AbstractPageProvider<DocumentModel>
public Collection<String> getCatalogLetters()
public boolean isSortable()
isSortable
in interface PageProvider<DocumentModel>
isSortable
in class AbstractPageProvider<DocumentModel>
public void refresh()
AbstractPageProvider
When overriding it, call super.refresh()
as last statement
to make sure that the PageProviderChangedListener
is called with
the up-to-date @{code PageProvider} state.
refresh
in interface PageProvider<DocumentModel>
refresh
in class AbstractPageProvider<DocumentModel>
Copyright © 2013 Nuxeo SA. All Rights Reserved.