Package 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

Modifier and Type	Field	Description
protected static final String	ALL_MODE
protected static final String	GROUPS_LISTING_MODE_PROPERTY
protected List<DocumentModel>	pageGroups
protected static final String	SEARCH_ONLY_MODE
protected static final String	SEARCH_OVERFLOW_ERROR_MESSAGE

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

currentEntryIndex, currentHigherNonEmptyPageIndex, currentSelectPage, definition, error, errorMessage, highlights, maxPageSize, name, offset, PAGEPROVIDER_TRACK_PROPERTY_NAME, pageProviderChangedListener, pageSize, pageSizeOptions, parameters, properties, quickFilters, resultsCount, searchDocumentModel, selectedEntries, SKIPPED_SCHEMAS_FOR_SEARCHFIELD, sortable, sortInfos, tracking

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

DEFAULT_MAX_PAGE_SIZE, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, HIGHLIGHT_CTX_DATA, PAGE_LIMIT_UNKNOWN, SKIP_AGGREGATES_PROP, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY

Constructor Summary

Constructors

Constructor	Description
AbstractGroupsPageProvider()

Method Summary

Modifier and Type	Method	Description
List<DocumentModel>	computeCurrentPage()
protected String	getFirstParameter()
protected String	getGroupListingMode()
boolean	isSortable()	This page provider does not support sort for now => override what may be contributed in the definition
protected void	pageChanged()	Page change hook, to override for custom behavior
void	refresh()	Refresh hook, to override for custom behavior
protected List<DocumentModel>	searchAllGroups()
protected List<DocumentModel>	searchGroups()

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

addQuickFilter, addSortInfo, fireSearchEvent, firstPage, getAggregateDefinitions, getAggregates, getAvailableQuickFilters, getBooleanProperty, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPage, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefaultMaxPageSize, getDefinition, getError, getErrorMessage, getHighlights, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getPageSizeOptions, getParameters, getParametersChanged, getProperties, getQuickFilters, getResultsCount, getResultsCountLimit, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, hasChangedParameters, hasError, incorporateAggregates, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSkipAggregates, isTrackingEnabled, lastPage, nextEntry, nextPage, notifyPageChanged, notifyRefresh, previousEntry, previousPage, searchDocumentModelChanged, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setHighlights, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setPageSizeOptions, setParameters, setProperties, setQuickFilters, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos, sortInfoChanged

Methods inherited from class java.lang.Object

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

Field Details

GROUPS_LISTING_MODE_PROPERTY

protected static final String GROUPS_LISTING_MODE_PROPERTY

See Also:

• Constant Field Values

ALL_MODE

protected static final String ALL_MODE

See Also:

• Constant Field Values

SEARCH_ONLY_MODE

protected static final String SEARCH_ONLY_MODE

See Also:

• Constant Field Values

SEARCH_OVERFLOW_ERROR_MESSAGE

protected static final String SEARCH_OVERFLOW_ERROR_MESSAGE

See Also:

• Constant Field Values

pageGroups

protected List<DocumentModel> pageGroups

Constructor Details

AbstractGroupsPageProvider

public AbstractGroupsPageProvider()

Method Details

computeCurrentPage

public List<DocumentModel> computeCurrentPage()

searchAllGroups

protected List<DocumentModel> searchAllGroups()

searchGroups

protected List<DocumentModel> searchGroups()

getGroupListingMode

protected String getGroupListingMode()

getFirstParameter

protected String getFirstParameter()

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>

pageChanged

protected void pageChanged()

Description copied from class: AbstractPageProvider

Page change hook, to override for custom behavior

When overriding it, call super.pageChanged() as last statement to make sure that the PageProviderChangedListener is called with the up-to-date @{code PageProvider} state.

Overrides:

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