org.nuxeo.ecm.platform.usermanager.providers

Class UsersPageProvider

java.lang.Object

org.nuxeo.ecm.platform.query.api.AbstractPageProvider<T>

org.nuxeo.ecm.platform.usermanager.providers.AbstractUsersPageProvider<DocumentModel>

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

All Implemented Interfaces:

Serializable, PageProvider<DocumentModel>

public class UsersPageProvider
extends AbstractUsersPageProvider<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 AbstractUsersPageProvider.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, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, PAGE_LIMIT_UNKNOWN, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY

Constructor Summary

Constructors

Constructor and Description
UsersPageProvider()

Method Summary

Methods

Modifier and Type	Method and Description
List<DocumentModel>	getCurrentPage() Returns the current page of results.

Methods inherited from class org.nuxeo.ecm.platform.usermanager.providers.AbstractUsersPageProvider

getCatalogLetters, isSortable, refresh

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, getPageLimit, 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, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageProviderChangedListener, 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

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