org.nuxeo.ecm.social.mini.message

Class MiniMessagePageProvider

java.lang.Object

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

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

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

All Implemented Interfaces:

Serializable, PageProvider<MiniMessage>

public class MiniMessagePageProvider
extends AbstractActivityPageProvider<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

Modifier and Type	Field and Description
static String	ACTOR_PROPERTY
static String	FOR_ACTOR_STREAM_TYPE
static String	FROM_ACTOR_STREAM_TYPE
static String	RELATIONSHIP_KIND_PROPERTY
static String	STREAM_TYPE_PROPERTY

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

Method Summary

Methods

Modifier and Type	Method and Description
List<MiniMessage>	getCurrentPage() Returns the current page of results.
boolean	isSortable() Returns if this provider is sortable
void	refresh() Forces refresh of the current page.

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

ACTOR_PROPERTY

public static final String ACTOR_PROPERTY

See Also:

Constant Field Values

RELATIONSHIP_KIND_PROPERTY

public static final String RELATIONSHIP_KIND_PROPERTY

See Also:

Constant Field Values

STREAM_TYPE_PROPERTY

public static final String STREAM_TYPE_PROPERTY

See Also:

Constant Field Values

FOR_ACTOR_STREAM_TYPE

public static final String FOR_ACTOR_STREAM_TYPE

See Also:

Constant Field Values

FROM_ACTOR_STREAM_TYPE

public static final String FROM_ACTOR_STREAM_TYPE

See Also:

Constant Field Values

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

isSortable

public boolean isSortable()

Description copied from interface: PageProvider

Returns if this provider is sortable

Specified by:

isSortable in interface PageProvider<MiniMessage>

Overrides:

isSortable in class AbstractPageProvider<MiniMessage>

refresh

public void refresh()

Description copied from interface: PageProvider

Forces refresh of the current page.

Specified by:

refresh in interface PageProvider<MiniMessage>

Overrides:

refresh in class AbstractPageProvider<MiniMessage>