org.nuxeo.ecm.activity

Interface ActivityStreamService

All Known Implementing Classes:

ActivityStreamServiceImpl

public interface ActivityStreamService

Service storing and querying activities.

It also uses contributed ActivityStreamFilters to store and filter activities for specific use cases.

Since:

5.5

Author:

Thomas Roger

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_ACTIVITIES To be used as filterId

Method Summary

Methods

Modifier and Type	Method and Description
Activity	addActivity(Activity activity) Add and store a new Activity.
ActivityReply	addActivityReply(Serializable activityId, ActivityReply activityReply) Add an ActivityReply to the Activity referenced by the activityId.
ActivitiesList	getActivities(Collection<Serializable> activityIds)
Activity	getActivity(Serializable activityId)
ActivityLinkBuilder	getActivityLinkBuilder(String name) Returns the ActivityLinkBuilder with the given name.
ActivityStream	getActivityStream(String name) Returns the ActivityStream with the given name, null if it does not exist.
ActivitiesList	query(String filterId, Map<String,Serializable> parameters) Returns the list of activities filtered by the given parameters using the ActivityStreamFilter referenced by filterId.
ActivitiesList	query(String filterId, Map<String,Serializable> parameters, long offset, long limit) Returns the list of activities filtered by the given parameters using the ActivityStreamFilter referenced by filterId.
void	removeActivities(Collection<Activity> activities) Remove the given activities.
ActivityReply	removeActivityReply(Serializable activityId, String activityReplyId) Remove an ActivityReply from the Activity referenced by the activityId.
ActivityMessage	toActivityMessage(Activity activity, Locale locale) Computes an ActivityMessage from the given activity and locale.
ActivityMessage	toActivityMessage(Activity activity, Locale locale, String activityLinkBuilderName) Computes an ActivityMessage from the given activity, locale and use .
ActivityReplyMessage	toActivityReplyMessage(ActivityReply activityReply, Locale locale) Computes an ActivityReplyMessage from the given activityReply and locale.
ActivityReplyMessage	toActivityReplyMessage(ActivityReply activityReply, Locale locale, String activityLinkBuilderName) Computes an ActivityReplyMessage from the given activityReply and locale.

Field Detail

ALL_ACTIVITIES

static final String ALL_ACTIVITIES

To be used as filterId

See Also:

Constant Field Values

Method Detail

getActivity

Activity getActivity(Serializable activityId)

getActivities

ActivitiesList getActivities(Collection<Serializable> activityIds)

addActivity

Activity addActivity(Activity activity)

Add and store a new Activity.

removeActivities

void removeActivities(Collection<Activity> activities)

Remove the given activities.

query

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

Returns the list of activities filtered by the given parameters using the ActivityStreamFilter referenced by filterId.

Parameters:

filterId - the id of the ActivityStreamFilter to use.

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.

Throws:

ClientRuntimeException - if there is no ActivityStreamFilter matching the given filterId.

query

ActivitiesList query(String filterId,
                   Map<String,Serializable> parameters)

Returns the list of activities filtered by the given parameters using the ActivityStreamFilter referenced by filterId.

Parameters:

filterId - the id of the ActivityStreamFilter to use.

parameters - this query parameters.

Throws:

ClientRuntimeException - if there is no ActivityStreamFilter matching the given filterId.

toActivityMessage

ActivityMessage toActivityMessage(Activity activity,
                                Locale locale)

Computes an ActivityMessage from the given activity and locale.

toActivityMessage

ActivityMessage toActivityMessage(Activity activity,
                                Locale locale,
                                String activityLinkBuilderName)

Computes an ActivityMessage from the given activity, locale and use .

toActivityReplyMessage

ActivityReplyMessage toActivityReplyMessage(ActivityReply activityReply,
                                          Locale locale)

Computes an ActivityReplyMessage from the given activityReply and locale.

Since:

5.6

toActivityReplyMessage

ActivityReplyMessage toActivityReplyMessage(ActivityReply activityReply,
                                          Locale locale,
                                          String activityLinkBuilderName)

Computes an ActivityReplyMessage from the given activityReply and locale.

Since:

5.6

getActivityStream

ActivityStream getActivityStream(String name)

Returns the ActivityStream with the given name, null if it does not exist.

getActivityLinkBuilder

ActivityLinkBuilder getActivityLinkBuilder(String name)

Returns the ActivityLinkBuilder with the given name.

If name is null, or if the ActivityLinkBuilder does not exist, fallback on the default one if any.

addActivityReply

ActivityReply addActivityReply(Serializable activityId,
                             ActivityReply activityReply)

Add an ActivityReply to the Activity referenced by the activityId.

Returns:

the updated activityReply

Since:

5.6

removeActivityReply

ActivityReply removeActivityReply(Serializable activityId,
                                String activityReplyId)

Remove an ActivityReply from the Activity referenced by the activityId.

Returns:

the removed ActivityReply if any, null otherwise

Since:

5.6