org.nuxeo.ecm.platform.usermanager.providers
Class UsersPageProvider

java.lang.Object
  org.nuxeo.ecm.platform.query.api.AbstractPageProvider<DocumentModel>
      org.nuxeo.ecm.platform.usermanager.providers.UsersPageProvider

All Implemented Interfaces:

Serializable, PageProvider<DocumentModel>

public class UsersPageProvider
extends AbstractPageProvider<DocumentModel>
implements PageProvider<DocumentModel>

Page provider listing users.

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.

Since:

5.4.2

Author:

Thomas Roger

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.nuxeo.ecm.platform.query.api.PageProvider

DEFAULT_MAX_PAGE_SIZE, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY

Constructor Summary

UsersPageProvider()

Method Summary

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() Forces refresh of the current page.

Methods inherited from class org.nuxeo.ecm.platform.query.api.AbstractPageProvider

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, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, last, lastPage, next, nextEntry, nextPage, previous, previousEntry, previousPage, rewind, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.platform.query.api.PageProvider

addSortInfo, firstPage, getCurrentEntry, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxPageSize, getName, getNumberOfPages, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, lastPage, nextEntry, nextPage, previousEntry, previousPage, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos

Constructor Detail

UsersPageProvider

public UsersPageProvider()

Method Detail

getCurrentPage

public List<DocumentModel> getCurrentPage()

Description copied from interface: PageProvider

Returns the current page of results.

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.

Specified by:

getCurrentPage in interface PageProvider<DocumentModel>

Specified by:

getCurrentPage in class AbstractPageProvider<DocumentModel>

Returns:

the current page

getCatalogLetters

public Collection<String> getCatalogLetters()

isSortable

public boolean isSortable()

This page provider does not support sort for now => override what may be contributed in the definition

Specified by:

isSortable in interface PageProvider<DocumentModel>

Overrides:

isSortable in class AbstractPageProvider<DocumentModel>

refresh

public void refresh()

Description copied from interface: PageProvider

Forces refresh of the current page.

Specified by:

refresh in interface PageProvider<DocumentModel>

Overrides:

refresh in class AbstractPageProvider<DocumentModel>