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

Class ManualSourceType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.forms.question.sources.ManualSourceType

All Implemented Interfaces:

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

public class ManualSourceType
extends AbstractSourceType

Class for creating choice list from manual source

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,ModelItem>	_manualChoicesItems	Map of ModelItems specific to ManualSourceType
static final String	ATTRIBUTE_GRID	Constant for element definition name of the select grid

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
ManualSourceType()

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
Map<String,ModelItem>	getModelItems()	Get the type model items
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
Map<ChoiceOption,I18nizableText>	searchEntries(Map<String,Object> contextParams, int limit, Object paginationData)	Provides the enumerated values with their optional label.

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

_getComputedComplexValue, _getComputedStringValue, _getQuestionFromParam, configure, getId, getJSConverter, getJSRenderer, getLabel, getStorageType, removeEmptyOrOtherValue, service, setPluginInfo, valueToJSONForClient

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_GRID

public static final String ATTRIBUTE_GRID

Constant for element definition name of the select grid

See Also:

• Constant Field Values

_manualChoicesItems

protected Map<String,ModelItem> _manualChoicesItems

Map of ModelItems specific to ManualSourceType

Constructor Details

ManualSourceType

public ManualSourceType()

Method Details

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.