org.nuxeo.ecm.social.activity.stream

Class UserActivityStreamPageProvider

java.lang.Object

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

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

org.nuxeo.ecm.social.activity.stream.UserActivityStreamPageProvider

All Implemented Interfaces:

Serializable, PageProvider<ActivityMessage>

public class UserActivityStreamPageProvider
extends AbstractActivityPageProvider<ActivityMessage>

Page provider listing activity messages for a given actor

This page provider requires four properties:

• the actor
• the CoreSession used to filter the Activities
• the user activity stream type: for the actor or from the actor
• the locale to internationalize the activity messages

Since:

5.5

Author:

Thomas Roger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVITY_LINK_BUILDER_NAME_PROPERTY
static String	ACTOR_PROPERTY
static String	CORE_SESSION_PROPERTY
static String	FOR_ACTOR_STREAM_TYPE
static String	FROM_ACTOR_STREAM_TYPE
static String	LOCALE_PROPERTY
static String	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
UserActivityStreamPageProvider()

Method Summary

Methods

Modifier and Type	Method and Description
List<ActivityMessage>	getCurrentPage() Returns the list of current page items.
boolean	isSortable() Returns if this provider is sortable
void	refresh() Refresh hook, to override for custom behavior

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

Field Detail

ACTOR_PROPERTY

public static final String ACTOR_PROPERTY

See Also:

Constant Field Values

LOCALE_PROPERTY

public static final String LOCALE_PROPERTY

See Also:

Constant Field Values

CORE_SESSION_PROPERTY

public static final String CORE_SESSION_PROPERTY

See Also:

Constant Field Values

STREAM_TYPE_PROPERTY

public static final String STREAM_TYPE_PROPERTY

See Also:

Constant Field Values

ACTIVITY_LINK_BUILDER_NAME_PROPERTY

public static final String ACTIVITY_LINK_BUILDER_NAME_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

UserActivityStreamPageProvider

public UserActivityStreamPageProvider()

Method Detail

getCurrentPage

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

Specified by:

getCurrentPage in class AbstractPageProvider<ActivityMessage>

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

Overrides:

isSortable in class AbstractPageProvider<ActivityMessage>

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

Overrides:

refresh in class AbstractPageProvider<ActivityMessage>