Package org.ametys.core.userpref

Class UserPreference<T>

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.DefaultElementDefinition<T>

org.ametys.core.userpref.UserPreference<T>

Type Parameters:

T - Type of the preference value

All Implemented Interfaces:

Comparable<ModelItem>, ElementDefinition<T>, ModelItem, Labelable, ModifiableLabelable

public class UserPreference<T>
extends DefaultElementDefinition<T>

Definition of a user preference.

Field Summary

Fields

Modifier and Type	Field	Description
protected I18nizableText	_displayGroup	the group in which to display the element
protected String	_managerRole	The storage manager role
protected long	_position	the position in the group where the element has to be displayed
protected boolean	_private	The private status.

Fields inherited from class org.ametys.runtime.model.DefaultElementDefinition

_logger

Fields inherited from class org.ametys.runtime.model.AbstractModelItem

__context, __serviceManager

Fields inherited from interface org.ametys.runtime.model.ElementDefinition

CONFIG_DEFAULT_VALUE_TYPE

Fields inherited from interface org.ametys.runtime.model.ModelItem

ITEM_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
UserPreference()	Default constructor
UserPreference(UserPreference<T> preferenceToCopy)	Constructor by copying an existing UserPreference.

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_toJSON(DefinitionContext context)	Converts the model item in a JSON map
I18nizableText	getDisplayGroup()	Retrieves the group in which to display the preference
String	getManagerRole()	Get the storage manager role.
long	getPosition()	Retrieves the position in the group where the preference has to be displayed
boolean	isPrivate()	Get whether the preference is private, i.e.
void	setDisplayGroup(I18nizableText displayGroup)	Sets the group in which to display the preference
void	setManagerRole(String managerRole)	Set the storage manager role.
void	setPosition(long position)	Sets the position of the preference in the group
void	setPrivate(boolean privateStatus)	Set the private status of the preference
String	toString()

Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition

_defaultValueToJSON, _getDefaultValues, _getSimpleDefaultValue, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getType, getValidator, getValidatorConfiguration, getWidget, getWidgetParameters, isMultiple, of, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setType, setValidator, setValidatorConfiguration, setWidget, setWidgetParameters, toSAX

Methods inherited from class org.ametys.runtime.model.AbstractModelItem

_getModelItemHelper, _shouldJSONBeEmpty, _widgetParameterToSAX, addItemChecker, compareTo, disableConditionsToJSON, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, hashCode, setContext, setDescription, setDisableConditions, setLabel, setModel, setName, setParent, setPluginName, setServiceManager, toJSON

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.ametys.runtime.model.ElementDefinition

isEditable

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

Methods inherited from interface org.ametys.runtime.model.ModelItem

addItemChecker, getDisableConditions, getItemCheckers, getModel, getParent, getPath, getPluginName, setDisableConditions, setModel, setParent, setPluginName, toJSON

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel, setName

Field Details

_managerRole

protected String _managerRole

The storage manager role

_private

protected boolean _private

The private status.

_displayGroup

protected I18nizableText _displayGroup

the group in which to display the element

_position

protected long _position

the position in the group where the element has to be displayed

Constructor Details

UserPreference

public UserPreference()

Default constructor

UserPreference

public UserPreference(UserPreference<T> preferenceToCopy)

Constructor by copying an existing UserPreference.

Parameters:

preferenceToCopy - The UserPreference to copy

Method Details

getManagerRole

public String getManagerRole()

Get the storage manager role.

Returns:

the manager role. Can be null to use the default storage manager.

setManagerRole

public void setManagerRole(String managerRole)

Set the storage manager role.

Parameters:

managerRole - the manager role to set. Can be null to use the default storage manager.

isPrivate

public boolean isPrivate()

Get whether the preference is private, i.e. should not be visible by the regular user preferences interface.

Returns:

true if the preference is private, false if it is public.

setPrivate

public void setPrivate(boolean privateStatus)

Set the private status of the preference

Parameters:

privateStatus - true if the preference is private, false if it is public.

getDisplayGroup

public I18nizableText getDisplayGroup()

Retrieves the group in which to display the preference

Returns:

the group

setDisplayGroup

public void setDisplayGroup(I18nizableText displayGroup)

Sets the group in which to display the preference

Parameters:

displayGroup - the group to set

getPosition

public long getPosition()

Retrieves the position in the group where the preference has to be displayed

Returns:

the position in the group

setPosition

public void setPosition(long position)

Sets the position of the preference in the group

Parameters:

position - the position to set

_toJSON

protected Map<String,Object> _toJSON(DefinitionContext context)

Description copied from class: AbstractModelItem

Converts the model item in a JSON map

Overrides:

_toJSON in class DefaultElementDefinition<T>

Parameters:

context - the context of the definition

Returns:

The model item as a JSON map

toString

public String toString()

Overrides:

toString in class AbstractModelItem