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

Class AbstractSourceType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ManualSourceType, ManualWithCostsSourceType, TableRefSourceType, UsersSourceType

public abstract class AbstractSourceType
extends AbstractLogEnabled
implements ChoiceSourceType, Serviceable, Configurable, PluginAware

Static class for creating ChoiceSourceType from xml congig

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_id	Id of source type
protected JSONUtils	_jsonUtils	JSON helper
protected I18nizableText	_label	Label of source type
protected String	_pluginName	Forms
static final String	QUESTION_PARAM_KEY	The 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
AbstractSourceType()

Method Summary

Modifier and Type	Method	Description
protected Object	_getComputedComplexValue(Object valueToJSONForClient, FormQuestion question, FormEntry entry)	Get computed complex value as user or content for choice list
protected Object	_getComputedStringValue(Object valueToJSONForClient, FormQuestion question, FormEntry entry)	Get computed string value for choice list
protected FormQuestion	_getQuestionFromParam(Map<String,Object> params)	Get question from params
void	configure(Configuration configuration)
List<String>	getFieldToDisableIfFormPublished()	Get field to disable if form is published
String	getId()	Get the type id
String	getJSConverter()	Get the js converter for the choice list
String	getJSRenderer()	Get the js renderer for the choice list
I18nizableText	getLabel()	Get the type label
String	getStorageType(FormQuestion question)	Get the storage type of the source type
Object	removeEmptyOrOtherValue(Object value)	Remove the empty values or values equal to '__interval_other' from received value
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
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.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.plugins.forms.question.sources.ChoiceSourceType

getModelItems, getViewItems, remoteData

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

getEntry, getTypedEntries, searchEntries

Field Details

QUESTION_PARAM_KEY

public static final String QUESTION_PARAM_KEY

The question param key

See Also:

• Constant Field Values

_jsonUtils

protected JSONUtils _jsonUtils

JSON helper

_pluginName

protected String _pluginName

Forms

_id

protected String _id

Id of source type

_label

protected I18nizableText _label

Label of source type

Constructor Details

AbstractSourceType

public AbstractSourceType()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: ChoiceSourceType

Get the type id

Specified by:

getId in interface ChoiceSourceType

Returns:

the id

getLabel

public I18nizableText getLabel()

Description copied from interface: ChoiceSourceType

Get the type label

Specified by:

getLabel in interface ChoiceSourceType

Returns:

the label

getFieldToDisableIfFormPublished

public List<String> getFieldToDisableIfFormPublished()

Description copied from interface: ChoiceSourceType

Get field to disable if form is published

Specified by:

getFieldToDisableIfFormPublished in interface ChoiceSourceType

Returns:

the list of field name

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

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

Returns:

the js renderer

getJSConverter

public String getJSConverter()

Description copied from interface: ChoiceSourceType

Get the js converter for the choice list

Specified by:

getJSConverter in interface ChoiceSourceType

Returns:

the js converter

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

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.

_getQuestionFromParam

protected FormQuestion _getQuestionFromParam(Map<String,Object> params)

Get question from params

Parameters:

params - the params

Returns:

the form question

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

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

_getComputedStringValue

protected Object _getComputedStringValue(Object valueToJSONForClient,
 FormQuestion question,
 FormEntry entry)
                                  throws Exception

Get computed string value for choice list

Parameters:

valueToJSONForClient - the value for this question

question - the question

entry - the entry

Returns:

the computed value

Throws:

Exception - if an error occurred during computing

_getComputedComplexValue

protected Object _getComputedComplexValue(Object valueToJSONForClient,
 FormQuestion question,
 FormEntry entry)
                                   throws Exception

Get computed complex value as user or content for choice list

Parameters:

valueToJSONForClient - the value for this question

question - the question

entry - the entry

Returns:

the computed value

Throws:

Exception - if an error occurred