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

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

addSortInfo, firstPage, getCurrentEntry, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxPageSize, getName, getNumberOfPages, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, lastPage, nextEntry, nextPage, previousEntry, previousPage, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, 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 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<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 interface: PageProvider

Forces refresh of the current page.

Specified by:

refresh in interface PageProvider<DashBoardItem>

Overrides:

refresh in class AbstractPageProvider<DashBoardItem>