org.nuxeo.ecm.rating

Class RatingActivityStreamFilter

java.lang.Object

org.nuxeo.ecm.rating.RatingActivityStreamFilter

All Implemented Interfaces:

ActivityStreamFilter

public class RatingActivityStreamFilter
extends Object
implements ActivityStreamFilter

Activity Stream filter handling rating activities.

The different queries this filter can handle are defined in the RatingActivityStreamFilter.QueryType enum.

Since:

5.6

Author:

Thomas Roger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RatingActivityStreamFilter.QueryType

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTOR_PARAMETER
static String	ASPECT_PARAMETER
static String	CONTEXT_PARAMETER
static String	ID
static String	QUERY_TYPE_PARAMETER
static String	RATING_PARAMETER
static String	TARGET_OBJECT_PARAMETER

Constructor Summary

Constructors

Constructor and Description
RatingActivityStreamFilter()

Method Summary

Methods

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	handleRemovedActivities(ActivityStreamService activityStreamService, Collection<Serializable> activityIds) Deprecated.
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

QUERY_TYPE_PARAMETER

public static final String QUERY_TYPE_PARAMETER

See Also:

Constant Field Values

TARGET_OBJECT_PARAMETER

public static final String TARGET_OBJECT_PARAMETER

See Also:

Constant Field Values

ASPECT_PARAMETER

public static final String ASPECT_PARAMETER

See Also:

Constant Field Values

ACTOR_PARAMETER

public static final String ACTOR_PARAMETER

See Also:

Constant Field Values

RATING_PARAMETER

public static final String RATING_PARAMETER

See Also:

Constant Field Values

CONTEXT_PARAMETER

public static final String CONTEXT_PARAMETER

See Also:

Constant Field Values

Constructor Detail

RatingActivityStreamFilter

public RatingActivityStreamFilter()

Method Detail

getId

public String getId()

Description copied from interface: ActivityStreamFilter

Returns the id of this ActivityStreamFilter.

Specified by:

getId in interface ActivityStreamFilter

isInterestedIn

public boolean isInterestedIn(Activity activity)

Description copied from interface: ActivityStreamFilter

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

Specified by:

isInterestedIn in interface ActivityStreamFilter

handleNewActivity

public void handleNewActivity(ActivityStreamService activityStreamService,
                     Activity activity)

Description copied from interface: ActivityStreamFilter

Called by the ActivityStreamService when a new Activity is stored.

The given activity must not be modified.

Specified by:

handleNewActivity in interface ActivityStreamFilter

handleRemovedActivities

@Deprecated
public void handleRemovedActivities(ActivityStreamService activityStreamService,
                                      Collection<Serializable> activityIds)

Deprecated.

Description copied from interface: ActivityStreamFilter

Called by the ActivityStreamService before removing the activities referenced by the given activityIds.

Specified by:

handleRemovedActivities in interface ActivityStreamFilter

handleRemovedActivities

public void handleRemovedActivities(ActivityStreamService activityStreamService,
                           ActivitiesList activities)

Description copied from interface: ActivityStreamFilter

Called by the ActivityStreamService before removing the given activities.

Specified by:

handleRemovedActivities in interface ActivityStreamFilter

handleRemovedActivityReply

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

Description copied from interface: ActivityStreamFilter

Called by the ActivityStreamService before removing the given activityReply.

Specified by:

handleRemovedActivityReply in interface ActivityStreamFilter

query

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

Description copied from interface: ActivityStreamFilter

Returns the list of activities filtered by the given parameters.

Specified by:

query in interface ActivityStreamFilter

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.