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.
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<Serializable> activityIds) Remove the Activities referenced by the given activityIds.
ActivityMessage	toActivityMessage(Activity activity, Locale locale) Computes an ActivityMessage from the given activity and locale.

Field Detail

ALL_ACTIVITIES

static final String ALL_ACTIVITIES

To be used as filterId

See Also:

Constant Field Values

Method Detail

addActivity

Activity addActivity(Activity activity)

Add and store a new Activity.

removeActivities

void removeActivities(Collection<Serializable> activityIds)

Remove the Activities referenced by the given activityIds.

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.

getActivityStream

ActivityStream getActivityStream(String name)

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