Package org.ametys.plugins.calendar.helpers

Class CalendarCategoriesHelper

java.lang.Object

org.ametys.plugins.calendar.helpers.CalendarCategoriesHelper

All Implemented Interfaces:

Component, Serviceable

public class CalendarCategoriesHelper
extends Object
implements Component, Serviceable

helper to manage calendar categories

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected JSONUtils	_jsonUtils	Json utils
protected UserPreferencesManager	_userPref	The user preferences
static String	ROLE	The component role.
protected static String	USER_PREF_ID	user pref id where the categories should be stored
protected static String	ZONEITEMID	Parameter name for the zone item id

Constructor Summary

Constructors

Constructor	Description
CalendarCategoriesHelper()

Method Summary

Modifier and Type	Method	Description
List<String>	getUserCategories(String siteName, String zoneItemId)	Get the user preferences for this calendar
List<String>	getUserCategories(UserIdentity identity, String siteName, String zoneItemId)	Get the user preferences for this calendar
List<String>	getUserCategories(Request request)	Get the user preferences for this calendar
void	service(ServiceManager manager)
boolean	setUserCategories(String siteName, String zoneItemId, List<String> categories)	Set the user preferences for this calendar
boolean	setUserCategories(UserIdentity identity, String siteName, String zoneItemId, List<String> categories)	Set the user preferences for this calendar
boolean	setUserCategories(Request request)	Set the user preferences for this calendar

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 component role.

ZONEITEMID

protected static final String ZONEITEMID

Parameter name for the zone item id

See Also:

Constant Field Values

USER_PREF_ID

protected static final String USER_PREF_ID

user pref id where the categories should be stored

See Also:

Constant Field Values

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_userPref

protected UserPreferencesManager _userPref

The user preferences

_jsonUtils

protected JSONUtils _jsonUtils

Json utils

Constructor Detail

CalendarCategoriesHelper

public CalendarCategoriesHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setUserCategories

public boolean setUserCategories(Request request)
                          throws UserPreferencesException

Set the user preferences for this calendar

Parameters:

request - the request from the service

Returns:

true if the preference was set

Throws:

UserPreferencesException - impossible to set the preference

setUserCategories

public boolean setUserCategories(String siteName,
                                 String zoneItemId,
                                 List<String> categories)
                          throws UserPreferencesException

Set the user preferences for this calendar

Parameters:

siteName - Site name

zoneItemId - Zone Item Id where the service is put

categories - categories to set

Returns:

true if the preference was set

Throws:

UserPreferencesException - impossible to set the preference

setUserCategories

public boolean setUserCategories(UserIdentity identity,
                                 String siteName,
                                 String zoneItemId,
                                 List<String> categories)
                          throws UserPreferencesException

Set the user preferences for this calendar

Parameters:

identity - User

siteName - Site name

zoneItemId - Zone Item Id where the service is put

categories - categories to set

Returns:

true if the preference was set

Throws:

UserPreferencesException - impossible to set the preference

getUserCategories

public List<String> getUserCategories(Request request)
                               throws UserPreferencesException

Get the user preferences for this calendar

Parameters:

request - the request from the service

Returns:

a List of categories

Throws:

UserPreferencesException - impossible to get the preference

getUserCategories

public List<String> getUserCategories(String siteName,
                                      String zoneItemId)
                               throws UserPreferencesException

Get the user preferences for this calendar

Parameters:

siteName - Site name

zoneItemId - Zone Item Id where the service is put

Returns:

a List of categories

Throws:

UserPreferencesException - impossible to get the preference

getUserCategories

public List<String> getUserCategories(UserIdentity identity,
                                      String siteName,
                                      String zoneItemId)
                               throws UserPreferencesException

Get the user preferences for this calendar

Parameters:

identity - User

siteName - Site name

zoneItemId - Zone Item Id where the service is put

Returns:

a List of categories

Throws:

UserPreferencesException - impossible to set the preference