Package org.nuxeo.ecm.platform.audit.provider

Class LatestCreatedUsersOrGroupsPageProvider

java.lang.Object

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

org.nuxeo.ecm.platform.audit.provider.LatestCreatedUsersOrGroupsPageProvider

All Implemented Interfaces:

Serializable, PageProvider<DocumentModel>

public class LatestCreatedUsersOrGroupsPageProvider
extends AbstractPageProvider<DocumentModel>

Since:

8.2

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CORE_SESSION_PROPERTY
protected List<DocumentModel>	currentPage
static String	LATEST_AUDITED_CREATED_USERS_OR_GROUPS_PROVIDER
static String	LATEST_CREATED_USERS_OR_GROUPS_PROVIDER
protected static String	POWER_USERS_GROUP

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

currentEntryIndex, currentHigherNonEmptyPageIndex, currentSelectPage, definition, error, errorMessage, highlights, log, 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
LatestCreatedUsersOrGroupsPageProvider()

Method Summary

Modifier and Type	Method	Description
protected boolean	canSearchUsersAndGroups(NuxeoPrincipal principal)
List<DocumentModel>	getCurrentPage()	Returns the list of current page items.
long	getResultsCountLimit()	Limit of number of results beyond which the page provider may not be able to compute PageProvider.getResultsCount() or navigate.
protected void	pageChanged()	Page change hook, to override for custom behavior

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

addQuickFilter, addSortInfo, fireSearchEvent, firstPage, getAggregateDefinitions, getAggregates, getAvailableQuickFilters, getBooleanProperty, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefaultMaxPageSize, getDefinition, getError, getErrorMessage, getHighlights, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getPageSizeOptions, getParameters, getParametersChanged, getProperties, getQuickFilters, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, hasChangedParameters, hasError, incorporateAggregates, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSkipAggregates, isSortable, isTrackingEnabled, lastPage, nextEntry, nextPage, notifyPageChanged, notifyRefresh, previousEntry, previousPage, refresh, 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 Detail

LATEST_CREATED_USERS_OR_GROUPS_PROVIDER

public static final String LATEST_CREATED_USERS_OR_GROUPS_PROVIDER

See Also:

Constant Field Values

LATEST_AUDITED_CREATED_USERS_OR_GROUPS_PROVIDER

public static final String LATEST_AUDITED_CREATED_USERS_OR_GROUPS_PROVIDER

See Also:

Constant Field Values

CORE_SESSION_PROPERTY

protected static final String CORE_SESSION_PROPERTY

See Also:

Constant Field Values

POWER_USERS_GROUP

protected static final String POWER_USERS_GROUP

See Also:

Constant Field Values

currentPage

protected List<DocumentModel> currentPage

Constructor Detail

LatestCreatedUsersOrGroupsPageProvider

public LatestCreatedUsersOrGroupsPageProvider()

Method Detail

getCurrentPage

public List<DocumentModel> getCurrentPage()

Description copied from class: AbstractPageProvider

Returns the list of current page items.

Custom implementation can be added here, based on the page provider properties, parameters and WhereClauseDefinition on the PageProviderDefinition, as well as search document, sort information, etc...

Implementation of this method usually consists in setting a non-null value to a field caching current items, and nullifying this field by overriding AbstractPageProvider.pageChanged() and AbstractPageProvider.refresh().

Fields AbstractPageProvider.errorMessage and AbstractPageProvider.error can also be filled to provide accurate feedback in case an error occurs during the search.

When items are retrieved, a call to AbstractPageProvider.setResultsCount(long) should be made to ensure proper pagination as implemented in this abstract class. The implementation in CoreQueryAndFetchPageProvider is a good example when the total results count is known.

If for performance reasons, for instance, the number of results cannot be known, a fall-back strategy can be applied to provide the "next" button but not the "last" one, by calling AbstractPageProvider.getCurrentHigherNonEmptyPageIndex() and AbstractPageProvider.setCurrentHigherNonEmptyPageIndex(int). In this case, CoreQueryDocumentPageProvider is a good example.

Specified by:

getCurrentPage in interface PageProvider<DocumentModel>

Specified by:

getCurrentPage in class AbstractPageProvider<DocumentModel>

Returns:

the current page

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

getResultsCountLimit

public long getResultsCountLimit()

Description copied from interface: PageProvider

Limit of number of results beyond which the page provider may not be able to compute PageProvider.getResultsCount() or navigate.

Requesting results beyond this limit may result in error. When PageProvider.getResultsCount() is negative, it means there may be more results than this limit.

0 means there is no limit.

Specified by:

getResultsCountLimit in interface PageProvider<DocumentModel>

Overrides:

getResultsCountLimit in class AbstractPageProvider<DocumentModel>

canSearchUsersAndGroups

protected boolean canSearchUsersAndGroups(NuxeoPrincipal principal)