Package org.ametys.plugins.workspaces.events.activitystream

Class ActivityStreamUserPreferencesManager

java.lang.Object

org.ametys.plugins.workspaces.events.activitystream.ActivityStreamUserPreferencesManager

All Implemented Interfaces:

Component, Serviceable

public class ActivityStreamUserPreferencesManager
extends Object
implements Component, Serviceable

Class handling the front-office user preferences for the filtered events service

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
ActivityStreamUserPreferencesManager()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getUserPreferences(String siteName, String zoneItemId)	Get the preferences of the current user
void	service(ServiceManager serviceManager)
void	setUserPreferences(String siteName, String zoneItemId, List<String> projectNames, Map<String,Object> eventTypes)	Set the preferences of the current user for the filtered events service

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

Constructor Detail

ActivityStreamUserPreferencesManager

public ActivityStreamUserPreferencesManager()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setUserPreferences

public void setUserPreferences(String siteName,
                               String zoneItemId,
                               List<String> projectNames,
                               Map<String,Object> eventTypes)
                        throws UserPreferencesException

Set the preferences of the current user for the filtered events service

Parameters:

siteName - the name of the site

zoneItemId - the id of the involved zone item

projectNames - the names of the projects to use as a filter

eventTypes - the enabled/disabled activity types sorted by category

Throws:

UserPreferencesException - if an error occurs while setting the user preferences

getUserPreferences

public Map<String,Object> getUserPreferences(String siteName,
                                                   String zoneItemId)
                                            throws UserPreferencesException

Get the preferences of the current user

Parameters:

siteName - the name of the site

zoneItemId - the id of the involved zone item

Returns:

the current user's preferences

Throws:

UserPreferencesException - if an error occurs while retrieving the preferences of the current user