org.nuxeo.ecm.platform.usermanager.providers

Class AbstractGroupsPageProvider<T>

java.lang.Object

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

org.nuxeo.ecm.platform.usermanager.providers.AbstractGroupsPageProvider<T>

All Implemented Interfaces:

Serializable, PageProvider<T>

Direct Known Subclasses:

GroupsPageProvider, NuxeoGroupsPageProvider

public abstract class AbstractGroupsPageProvider<T>
extends AbstractPageProvider<T>

Abstract Page provider listing groups.

This page provider requires one parameter: the first one to be filled with the search string.

This page provider requires the property GROUPS_LISTING_MODE_PROPERTY to be filled with a the listing mode to use.

Since:

5.8

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
AbstractGroupsPageProvider()

Method Summary

Methods

Modifier and Type	Method and Description
List<DocumentModel>	computeCurrentPage()
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

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

addSortInfo, firstPage, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPage, 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

AbstractGroupsPageProvider

public AbstractGroupsPageProvider()

Method Detail

computeCurrentPage

public List<DocumentModel> computeCurrentPage()

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<T>

Overrides:

isSortable in class AbstractPageProvider<T>

refresh

public void refresh()

Description copied from class: AbstractPageProvider

Refresh hook, to override for custom behavior

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.

Specified by:

refresh in interface PageProvider<T>

Overrides:

refresh in class AbstractPageProvider<T>