org.nuxeo.ecm.social.mini.message

Class MiniMessagePageProvider

java.lang.Object

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

org.nuxeo.ecm.activity.AbstractActivityPageProvider<T>

org.nuxeo.ecm.social.mini.message.AbstractMiniMessagePageProvider<MiniMessage>

org.nuxeo.ecm.social.mini.message.MiniMessagePageProvider

All Implemented Interfaces:

Serializable, PageProvider<MiniMessage>

public class MiniMessagePageProvider
extends AbstractMiniMessagePageProvider<MiniMessage>
implements PageProvider<MiniMessage>

Page provider listing mini messages for a given actor

This page provider requires two properties: the first one to be filled with the actor, and the second one to be filled with the relationship kind to use.

Since:

5.5

Author:

Thomas Roger

See Also:

Serialized Form

Field Summary

Fields inherited from class org.nuxeo.ecm.social.mini.message.AbstractMiniMessagePageProvider

ACTOR_PROPERTY, FOR_ACTOR_STREAM_TYPE, FROM_ACTOR_STREAM_TYPE, LOCALE_PROPERTY, RELATIONSHIP_KIND_PROPERTY, STREAM_TYPE_PROPERTY

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

Method Summary

Methods

Modifier and Type	Method and Description
List<MiniMessage>	getCurrentPage() Returns the current page of results.

Methods inherited from class org.nuxeo.ecm.social.mini.message.AbstractMiniMessagePageProvider

isSortable, refresh

Methods inherited from class org.nuxeo.ecm.activity.AbstractActivityPageProvider

getNextOffset

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, getPageLimit, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, 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, getCurrentEntry, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getParameters, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasChangedParameters, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSortable, lastPage, nextEntry, nextPage, previousEntry, previousPage, refresh, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos

Constructor Detail

MiniMessagePageProvider

public MiniMessagePageProvider()

Method Detail

getCurrentPage

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

Specified by:

getCurrentPage in class AbstractPageProvider<MiniMessage>

Returns:

the current page