org.nuxeo.ecm.activity

Interface ActivityStreamFilter

All Known Implementing Classes:

LikesCountActivityStreamFilter, RatingActivityStreamFilter

public interface ActivityStreamFilter

Filter called by the ActivityStreamService to store and filter activities for specific use cases.

Since:

5.5

Author:

Thomas Roger

Method Summary

Modifier and Type	Method and Description
String	getId() Returns the id of this ActivityStreamFilter.
void	handleNewActivity(ActivityStreamService activityStreamService, Activity activity) Called by the ActivityStreamService when a new Activity is stored.
void	handleRemovedActivities(ActivityStreamService activityStreamService, ActivitiesList activities) Called by the ActivityStreamService before removing the given activities.
void	handleRemovedActivityReply(ActivityStreamService activityStreamService, Activity activity, ActivityReply activityReply) Called by the ActivityStreamService before removing the given activityReply.
boolean	isInterestedIn(Activity activity) Returns true if this ActivityStreamFilter is interested in the given activity, false otherwise.
ActivitiesList	query(ActivityStreamService activityStreamService, Map<String,Serializable> parameters, long offset, long limit) Returns the list of activities filtered by the given parameters.

Method Detail

getId

String getId()

Returns the id of this ActivityStreamFilter.

isInterestedIn

boolean isInterestedIn(Activity activity)

Returns true if this ActivityStreamFilter is interested in the given activity, false otherwise.

handleNewActivity

void handleNewActivity(ActivityStreamService activityStreamService,
                       Activity activity)

Called by the ActivityStreamService when a new Activity is stored.

The given activity must not be modified.

handleRemovedActivities

void handleRemovedActivities(ActivityStreamService activityStreamService,
                             ActivitiesList activities)

Called by the ActivityStreamService before removing the given activities.

Since:

5.6

handleRemovedActivityReply

void handleRemovedActivityReply(ActivityStreamService activityStreamService,
                                Activity activity,
                                ActivityReply activityReply)

Called by the ActivityStreamService before removing the given activityReply.

Since:

5.6

query

ActivitiesList query(ActivityStreamService activityStreamService,
                     Map<String,Serializable> parameters,
                     long offset,
                     long limit)

Returns the list of activities filtered by the given parameters.

Parameters:

activityStreamService - the main ActivityStreamService

parameters - this query parameters.

offset - the offset (starting at 0) into the list of activities.

limit - the maximum number of activities to retrieve, or 0 for all of them.