Package org.ametys.plugins.forms.question.sources

Class UsersSourceType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.question.sources.AbstractSourceType

org.ametys.plugins.forms.question.sources.UsersSourceType

All Implemented Interfaces:

LazyEnumerator<ChoiceOption>, ChoiceSourceType, LogEnabled, PluginAware, Configurable, Serviceable

public class UsersSourceType
extends AbstractSourceType

Class for creating users choice list from a population

Field Summary

Fields

Modifier and Type	Field	Description
protected UserAndGroupSearchManager	_userAndGroupSearchManager	The user and group search manager
protected UserManager	_userManager	The user manager
protected Map<String,ModelItem>	_usersSourceItems	Map of ModelItems specific to UsersSourceType
static final String	ATTRIBUTE_POPULATION_ID	Constant for element definition name of the population id

Fields inherited from class org.ametys.plugins.forms.question.sources.AbstractSourceType

_id, _jsonUtils, _label, _pluginName, QUESTION_PARAM_KEY

Fields inherited from interface org.ametys.plugins.forms.enumerators.LazyEnumerator

LANG_PARAMETER_KEY, PATTERN_PARAMETER_KEY, SORT_PARAMETER_KEY

Constructor Summary

Constructors

Constructor	Description
UsersSourceType()

Method Summary

Modifier and Type	Method	Description
I18nizableText	getEntry(ChoiceOption value, Map<String,Object> contextParams)	Retrieves a single label from a value.
List<String>	getFieldToDisableIfFormPublished()	Get field to disable if form is published
String	getJSRenderer()	Get the js renderer for the choice list
Map<String,ModelItem>	getModelItems()	Get the type model items
String	getStorageType(FormQuestion question)	Get the storage type of the source type
Map<ChoiceOption,I18nizableText>	getTypedEntries(Map<String,Object> contextParams)	Provides the enumerated values with their optional label.
List<ViewItem>	getViewItems()	Get the view items for the main tab
boolean	remoteData()	true if the enumerator has remote data and need lazy loading
Object	removeEmptyOrOtherValue(Object value)	Remove the empty values or values equal to '__interval_other' from received value
Map<ChoiceOption,I18nizableText>	searchEntries(Map<String,Object> contextParams, int limit, Object paginationData)	Provides the enumerated values with their optional label.
void	service(ServiceManager manager)
Object	valueToJSONForClient(Object value, FormQuestion question, FormEntry entry, ModelItem modelItem)	Convert the entry value into a JSON object to use client side

Methods inherited from class org.ametys.plugins.forms.question.sources.AbstractSourceType

_getComputedComplexValue, _getComputedStringValue, _getQuestionFromParam, configure, getId, getJSConverter, getLabel, setPluginInfo

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

ATTRIBUTE_POPULATION_ID

public static final String ATTRIBUTE_POPULATION_ID

Constant for element definition name of the population id

See Also:

• Constant Field Values

_usersSourceItems

protected Map<String,ModelItem> _usersSourceItems

Map of ModelItems specific to UsersSourceType

_userManager

protected UserManager _userManager

The user manager

_userAndGroupSearchManager

protected UserAndGroupSearchManager _userAndGroupSearchManager

The user and group search manager

Constructor Details

UsersSourceType

public UsersSourceType()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSourceType

Throws:

ServiceException

getModelItems

public Map<String,ModelItem> getModelItems()

Description copied from interface: ChoiceSourceType

Get the type model items

Returns:

a map of the model items

getViewItems

public List<ViewItem> getViewItems()

Description copied from interface: ChoiceSourceType

Get the view items for the main tab

Returns:

a list of view items

getFieldToDisableIfFormPublished

public List<String> getFieldToDisableIfFormPublished()

Description copied from interface: ChoiceSourceType

Get field to disable if form is published

Specified by:

getFieldToDisableIfFormPublished in interface ChoiceSourceType

Overrides:

getFieldToDisableIfFormPublished in class AbstractSourceType

Returns:

the list of field name

remoteData

public boolean remoteData()

Description copied from interface: ChoiceSourceType

true if the enumerator has remote data and need lazy loading

Returns:

true if the enumerator has remote data and need lazy loading

getEntry

public I18nizableText getEntry(ChoiceOption value,
 Map<String,Object> contextParams)
                        throws Exception

Description copied from interface: LazyEnumerator

Retrieves a single label from a value.

Parameters:

value - the value.

contextParams - the search contextual parameters

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.

getTypedEntries

public Map<ChoiceOption,I18nizableText> getTypedEntries(Map<String,Object> contextParams)
                                                 throws Exception

Description copied from interface: LazyEnumerator

Provides the enumerated values with their optional label.

Parameters:

contextParams - the search contextual parameters

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

searchEntries

public Map<ChoiceOption,I18nizableText> searchEntries(Map<String,Object> contextParams,
 int limit,
 Object paginationData)
                                               throws Exception

Description copied from interface: LazyEnumerator

Provides the enumerated values with their optional label.

Parameters:

contextParams - the search contextual parameters

limit - the limit of entries

paginationData - the data to process pagination

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

getStorageType

public String getStorageType(FormQuestion question)

Description copied from interface: ChoiceSourceType

Get the storage type of the source type

Specified by:

getStorageType in interface ChoiceSourceType

Overrides:

getStorageType in class AbstractSourceType

Parameters:

question - the question

Returns:

the storage type

getJSRenderer

public String getJSRenderer()

Description copied from interface: ChoiceSourceType

Get the js renderer for the choice list

Specified by:

getJSRenderer in interface ChoiceSourceType

Overrides:

getJSRenderer in class AbstractSourceType

Returns:

the js renderer

removeEmptyOrOtherValue

public Object removeEmptyOrOtherValue(Object value)

Description copied from interface: ChoiceSourceType

Remove the empty values or values equal to '__interval_other' from received value

Specified by:

removeEmptyOrOtherValue in interface ChoiceSourceType

Overrides:

removeEmptyOrOtherValue in class AbstractSourceType

Parameters:

value - the receive value

Returns:

the value without empty sub-values or without '__interval_other' if the other option is chosen. If the value is empty or equal to the other value, it returns null.

valueToJSONForClient

public Object valueToJSONForClient(Object value,
 FormQuestion question,
 FormEntry entry,
 ModelItem modelItem)
                            throws Exception

Description copied from interface: ChoiceSourceType

Convert the entry value into a JSON object to use client side

Specified by:

valueToJSONForClient in interface ChoiceSourceType

Overrides:

valueToJSONForClient in class AbstractSourceType

Parameters:

value - the value to convert

question - the form question

entry - the form entry

modelItem - the model item

Returns:

The value as JSON

Throws:

Exception - if an error occurred