Package org.ametys.core.userpref

Class UserPreferencesExtensionPoint

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint<UserPreferenceProvider>

org.ametys.core.userpref.UserPreferencesExtensionPoint

All Implemented Interfaces:

LogEnabled, ExtensionPoint<UserPreferenceProvider>, Disposable, Initializable, Component, Contextualizable, Serviceable, ThreadSafe

public class UserPreferencesExtensionPoint
extends AbstractThreadSafeComponentExtensionPoint<UserPreferenceProvider>

Extension point holding all UserPreference definitions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	Avalon Role

Fields inherited from class org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint

_cocoonManager, _context, _manager

Constructor Summary

Constructors

Constructor	Description
UserPreferencesExtensionPoint()

Method Summary

Modifier and Type	Method	Description
Map<I18nizableText,List<UserPreference>>	getCategorizedPreferences(Map<String,String> contextVars)	Get all the preferences, classified by group and ordered.
protected Map<I18nizableText,List<UserPreference>>	getCategorizedPreferencesMap(Map<String,String> contextVars)	Compute the grouped preferences map.
protected Map<String,UserPreference>	getPreferencesMap(Map<String,String> contextVars)	Compute the preferences map.
UserPreference	getUserPreference(Map<String,String> contextVars, String id)	Get all the declared user preferences.
Map<String,UserPreference>	getUserPreferences(Map<String,String> contextVars)	Get all the declared user preferences.
void	initialize()
void	validatePreferences(Map<String,String> contextVars, Map<String,String> values, UserPreferencesErrors errors)	Validate preference values.

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

addComponent, addExtension, contextualize, dispose, getExtension, getExtensionsIds, hasExtension, initializeExtensions, service

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

ROLE

public static final String ROLE

Avalon Role

Constructor Details

UserPreferencesExtensionPoint

public UserPreferencesExtensionPoint()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractThreadSafeComponentExtensionPoint<UserPreferenceProvider>

Throws:

Exception

getUserPreference

public UserPreference getUserPreference(Map<String,String> contextVars,
 String id)

Get all the declared user preferences.

Parameters:

contextVars - The context variables including environment elements

id - The preference id

Returns:

the user preferences (read-only collection).

getUserPreferences

public Map<String,UserPreference> getUserPreferences(Map<String,String> contextVars)

Get all the declared user preferences.

Parameters:

contextVars - The context variables including environment elements

Returns:

the user preferences (read-only collection).

getCategorizedPreferences

public Map<I18nizableText,List<UserPreference>> getCategorizedPreferences(Map<String,String> contextVars)

Get all the preferences, classified by group and ordered.

Parameters:

contextVars - The context variables including environment elements

Returns:

the preferences classified by group and ordered.

validatePreferences

public void validatePreferences(Map<String,String> contextVars,
 Map<String,String> values,
 UserPreferencesErrors errors)

Validate preference values.

Parameters:

contextVars - The context variables including environment elements

values - the values.

errors - the errors object to fill in.

getPreferencesMap

protected Map<String,UserPreference> getPreferencesMap(Map<String,String> contextVars)

Compute the preferences map.

Parameters:

contextVars - The context variables including environment elements

Returns:

the preferences map.

getCategorizedPreferencesMap

protected Map<I18nizableText,List<UserPreference>> getCategorizedPreferencesMap(Map<String,String> contextVars)

Compute the grouped preferences map.

Parameters:

contextVars - The context variables including environment elements

Returns:

the grouped preferences map.