public class NuxeoPrincipalsPageProvider extends AbstractUsersPageProvider<NuxeoPrincipal>
NuxeoPrincipals.DEFAULT_MAX_PAGE_SIZE, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, PAGE_LIMIT_UNKNOWN, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY| Constructor and Description |
|---|
NuxeoPrincipalsPageProvider() |
| Modifier and Type | Method and Description |
|---|---|
List<NuxeoPrincipal> |
getCurrentPage()
Returns the list of current page items.
|
void |
refresh()
Refresh hook, to override for custom behavior
|
getCatalogLetters, isSortableaddSortInfo, firstPage, getAggregateDefinitions, getAggregates, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, hasChangedParameters, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, last, lastPage, next, nextEntry, nextPage, previous, previousEntry, previousPage, rewind, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfospublic List<NuxeoPrincipal> getCurrentPage()
AbstractPageProvider
Custom implementation can be added here, based on the page provider
properties, parameters and WhereClauseDefinition on the
PageProviderDefinition, as well as search document, sort
information, etc...
Implementation of this method usually consists in setting a non-null
value to a field caching current items, and nullifying this field by
overriding AbstractPageProvider.pageChanged() and AbstractPageProvider.refresh().
Fields AbstractPageProvider.errorMessage and AbstractPageProvider.error can also be filled to
provide accurate feedback in case an error occurs during the search.
When items are retrieved, a call to AbstractPageProvider.setResultsCount(long)
should be made to ensure proper pagination as implemented in this
abstract class. The implementation in
CoreQueryAndFetchPageProvider is a good example when the total
results count is known.
If for performance reasons, for instance, the number of results cannot
be known, a fall-back strategy can be applied to provide the "next"
button but not the "last" one, by calling
AbstractPageProvider.getCurrentHigherNonEmptyPageIndex() and
AbstractPageProvider.setCurrentHigherNonEmptyPageIndex(int). In this case,
CoreQueryDocumentPageProvider is a good example.
getCurrentPage in interface PageProvider<NuxeoPrincipal>getCurrentPage in class AbstractPageProvider<NuxeoPrincipal>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<NuxeoPrincipal>refresh in class AbstractUsersPageProvider<NuxeoPrincipal>Copyright © 2014 Nuxeo SA. All rights reserved.