Package org.ametys.plugins.workspaces.activities.activitystream

Class ActivityStreamServiceComponent

java.lang.Object

org.ametys.plugins.workspaces.activities.activitystream.ActivityStreamServiceComponent

All Implemented Interfaces:

Component, Contextualizable, Serviceable

public class ActivityStreamServiceComponent
extends Object
implements Serviceable, Component, Contextualizable

Component to return a map for action to get the activities for activity stream

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
ActivityStreamServiceComponent()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
Map<String,Object>	getActivityStream(int limit, boolean allActivities, boolean markAsRead)	Get the activity stream of the current user.
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The avalon role

Constructor Details

ActivityStreamServiceComponent

public ActivityStreamServiceComponent()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getActivityStream

public Map<String,Object> getActivityStream(int limit,
 boolean allActivities,
 boolean markAsRead)
                                     throws UserPreferencesException

Get the activity stream of the current user. In project context, only the activities of the current project are returned, unless allActivities is true.

Parameters:

limit - The max number of results

allActivities - Set to true to force to get activities from all projects of the current user, even if we are in a project context

markAsRead - If true mark the activities as read

Returns:

The activity stream

Throws:

UserPreferencesException - If an error occurs while marking activities as read