Package org.ametys.plugins.workspaces.project.favorites

Class FavoritesHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.project.favorites.FavoritesHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class FavoritesHelper
extends AbstractLogEnabled
implements Component, Serviceable

About setting a project as a favorite project for a user

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected JSONUtils	_jsonUtils	The JSON utils
protected ProjectManager	_projectManager	The project manager
protected UserPreferencesExtensionPoint	_userPrefEP	The user preferences extension point
protected UserPreferencesManager	_userPrefManager	The user preferences manager
static final String	ROLE	The avalon role
static final String	USERPREFS_ID	the id of the user prefs for favorites preferences

Constructor Summary

Constructors

Constructor	Description
FavoritesHelper()

Method Summary

Modifier and Type	Method	Description
Set<String>	getFavorites(UserIdentity userIdentity)	Get the favorites projects of a user
void	service(ServiceManager manager)
boolean	setFavoriteProject(String projectName, boolean favorite)	The current user change a favorite status for a given project

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

USERPREFS_ID

public static final String USERPREFS_ID

the id of the user prefs for favorites preferences

See Also:

• Constant Field Values

ROLE

public static final String ROLE

The avalon role

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils

_userPrefManager

protected UserPreferencesManager _userPrefManager

The user preferences manager

_userPrefEP

protected UserPreferencesExtensionPoint _userPrefEP

The user preferences extension point

_projectManager

protected ProjectManager _projectManager

The project manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Details

FavoritesHelper

public FavoritesHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getFavorites

public Set<String> getFavorites(UserIdentity userIdentity)

Get the favorites projects of a user

Parameters:

userIdentity - The user to consider

Returns:

The non null list of favorite projects names

setFavoriteProject

public boolean setFavoriteProject(String projectName,
 boolean favorite)

The current user change a favorite status for a given project

Parameters:

projectName - The name of the project

favorite - The new favorite status

Returns:

true if successful