org.nuxeo.ecm.platform.usermanager.providers

Class AbstractGroupsPageProvider

java.lang.Object

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

org.nuxeo.ecm.platform.usermanager.providers.AbstractGroupsPageProvider

All Implemented Interfaces:

Serializable, PageProvider<DocumentModel>

Direct Known Subclasses:

GroupsPageProvider, ShibbolethGroupsPageProvider

public abstract class AbstractGroupsPageProvider
extends AbstractPageProvider<DocumentModel>

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

Constructors

Constructor and Description
AbstractGroupsPageProvider()

Method Summary

Methods

Modifier and Type	Method and Description
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

Constructor Detail

AbstractGroupsPageProvider

public AbstractGroupsPageProvider()

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

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>