org.nuxeo.ecm.platform.task.providers

Class UserTaskPageProvider

java.lang.Object

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

org.nuxeo.ecm.platform.task.providers.UserTaskPageProvider

All Implemented Interfaces:

Serializable, PageProvider<DashBoardItem>

public class UserTaskPageProvider
extends AbstractPageProvider<DashBoardItem>
implements PageProvider<DashBoardItem>

Page provider for DashBoardItem elements.

Useful for content views displaying users' tasks.

WARNING: this page provider does not handle sorting, and its pagination management is not efficient (done in post filter).

This page provider requires the property CORE_SESSION_PROPERTY to be filled with a core session. It also accepts an optional property FILTER_DOCS_FROM_TRASH, defaulting to true.

Since:

5.5

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CORE_SESSION_PROPERTY
static String	FILTER_DOCS_FROM_TRASH

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

Method Summary

Methods

Modifier and Type	Method and Description
List<DashBoardItem>	getCurrentPage() Returns the list of current page items.
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, getAggregateDefinitions, getAggregates, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, 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

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

addSortInfo, firstPage, getAggregateDefinitions, getAggregates, getCurrentEntry, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, hasChangedParameters, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, lastPage, nextEntry, nextPage, previousEntry, previousPage, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos

Field Detail

CORE_SESSION_PROPERTY

public static final String CORE_SESSION_PROPERTY

See Also:

Constant Field Values

FILTER_DOCS_FROM_TRASH

public static final String FILTER_DOCS_FROM_TRASH

See Also:

Constant Field Values

Constructor Detail

UserTaskPageProvider

public UserTaskPageProvider()

Method Detail

getCurrentPage

public List<DashBoardItem> 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<DashBoardItem>

Specified by:

getCurrentPage in class AbstractPageProvider<DashBoardItem>

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

Overrides:

isSortable in class AbstractPageProvider<DashBoardItem>

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

Overrides:

refresh in class AbstractPageProvider<DashBoardItem>