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
UserPreference	getUserPreference(Map<String,String> contextVars, String name)	Get the declared user preference with the given name.
Collection<UserPreference>	getUserPreferences(Map<String,String> contextVars)	Get all the declared user preferences.
View	getUserPreferencesView(boolean excludePrivate, Map<String,String> contextVars)	Retrieves the view with all user preferences, classified by group and ordered.
View	getUserPreferencesView(Map<String,String> contextVars)	Retrieves the view with all user preferences, classified by group and ordered.

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

addComponent, addExtension, contextualize, dispose, getExtension, getExtensionsIds, hasExtension, initialize, 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

getUserPreference

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

Get the declared user preference with the given name.

Parameters:

contextVars - The context variables including environment elements

name - The preference's name

Returns:

the user preference, or null if none has been found.

getUserPreferences

public Collection<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).

getUserPreferencesView

public View getUserPreferencesView(Map<String,String> contextVars)

Retrieves the view with all user preferences, classified by group and ordered.

Parameters:

contextVars - The context variables including environment elements

Returns:

the view with all user preferences, classified by group and ordered.

getUserPreferencesView

public View getUserPreferencesView(boolean excludePrivate,
 Map<String,String> contextVars)

Retrieves the view with all user preferences, classified by group and ordered.

Parameters:

excludePrivate - true to exclude private preferences from the view, false otherwise

contextVars - The context variables including environment elements

Returns:

the view with all user preferences, classified by group and ordered.