Package org.ametys.plugins.forms.question.types

Class ComputedQuestionType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.question.types.AbstractStaticFormQuestionType

org.ametys.plugins.forms.question.types.ComputedQuestionType

All Implemented Interfaces:

FormQuestionType, ConfidentialAwareQuestionType, LogEnabled, PluginAware, Configurable, Serviceable

public class ComputedQuestionType
extends AbstractStaticFormQuestionType
implements ConfidentialAwareQuestionType

Class for creating computed question

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_COMPUTING_TYPE	Constant for computing attribute.
static final String	DEFAULT_TITLE	Constant for default title

Fields inherited from class org.ametys.plugins.forms.question.types.AbstractStaticFormQuestionType

_category, _description, _formQuestionModel, _i18nUtils, _iconGlyph, _id, _label, _pluginName, _priority, _scripts, _xslt

Fields inherited from interface org.ametys.plugins.forms.question.types.ConfidentialAwareQuestionType

ATTRIBUTE_CONFIDENTIALITY

Constructor Summary

Constructors

Constructor	Description
ComputedQuestionType()

Method Summary

Modifier and Type	Method	Description
protected SimpleViewItemGroup	_getAdvancedTab()	Define the content of the advanced tab
protected SimpleViewItemGroup	_getMainTab()	Define the content of the main tab
protected List<ModelItem>	_getModelItems()	Get the list of ModelItems
protected List<ViewItemGroup>	_getTabs(Form form)	Get the list of tabs that will be added in the question view.
boolean	canBeAnsweredByUser(FormQuestion question)	Return true if the type of question can be answered by user.
ComputingType	getComputingType(FormQuestion question)	Get the computing type
I18nizableText	getDefaultTitle()	Get the default title depending on type
List<String>	getFieldToDisableIfFormPublished(FormQuestion question)	Get field to disable if form is published
String	getJSRenderer(FormQuestion question)	Get the js renderer for the choice list
String	getStorageType(FormQuestion question)	Get the storage type of the question type
boolean	isCacheable(FormQuestion question)	Return true if the type of question can be cacheable.
boolean	isQuestionConfigured(FormQuestion question)	Say if question needs more configuration to be used
boolean	onlyForDisplay(FormQuestion question)	Return true if the type of question is only for display.
void	saxAdditionalInfos(ContentHandler contentHandler, FormQuestion question)	Sax additional informations for the question type
void	saxEntryValue(ContentHandler contentHandler, FormQuestion question, FormEntry entry)	Sax the entry value depending on the question type
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.types.AbstractStaticFormQuestionType

_createAdvancedTab, _createMainTab, _getEntryModelItem, _getRulesTab, configure, doAdditionalOperations, getCategory, getDescription, getDisplayOrder, getDisplayXSLT, getEntryModel, getIconGlyph, getId, getLabel, getModel, getScripts, getView, setPluginInfo, validateEntryValues, validateQuestionValues

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.types.ConfidentialAwareQuestionType

getConfidentialityModelItem, getConfidentialityViewElement

Methods inherited from interface org.ametys.plugins.forms.question.FormQuestionType

getJSConverter

Field Details

ATTRIBUTE_COMPUTING_TYPE

public static final String ATTRIBUTE_COMPUTING_TYPE

Constant for computing attribute.

See Also:

• Constant Field Values

DEFAULT_TITLE

public static final String DEFAULT_TITLE

Constant for default title

See Also:

• Constant Field Values

Constructor Details

ComputedQuestionType

public ComputedQuestionType()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractStaticFormQuestionType

Throws:

ServiceException

_getModelItems

protected List<ModelItem> _getModelItems()

Description copied from class: AbstractStaticFormQuestionType

Get the list of ModelItems

Overrides:

_getModelItems in class AbstractStaticFormQuestionType

Returns:

a list of ModelItems

_getTabs

protected List<ViewItemGroup> _getTabs(Form form)

Description copied from class: AbstractStaticFormQuestionType

Get the list of tabs that will be added in the question view. The list returned by this method should include the tab provided by _getTabs

Specified by:

_getTabs in class AbstractStaticFormQuestionType

Parameters:

form - the form

Returns:

the tabs

_getMainTab

protected SimpleViewItemGroup _getMainTab()

Define the content of the main tab

Returns:

the main tab definition

_getAdvancedTab

protected SimpleViewItemGroup _getAdvancedTab()

Define the content of the advanced tab

Returns:

the advanced tab definition

getStorageType

public String getStorageType(FormQuestion question)

Description copied from interface: FormQuestionType

Get the storage type of the question type

Specified by:

getStorageType in interface FormQuestionType

Parameters:

question - the question

Returns:

the storage type

saxAdditionalInfos

public void saxAdditionalInfos(ContentHandler contentHandler,
 FormQuestion question)
                        throws SAXException

Description copied from interface: FormQuestionType

Sax additional informations for the question type

Specified by:

saxAdditionalInfos in interface FormQuestionType

Overrides:

saxAdditionalInfos in class AbstractStaticFormQuestionType

Parameters:

contentHandler - the content handler

question - the question

Throws:

SAXException - if a saxing error occurred

isQuestionConfigured

public boolean isQuestionConfigured(FormQuestion question)

Description copied from interface: FormQuestionType

Say if question needs more configuration to be used

Specified by:

isQuestionConfigured in interface FormQuestionType

Overrides:

isQuestionConfigured in class AbstractStaticFormQuestionType

Parameters:

question - the current question

Returns:

false if question needs more configuration, true by default

getComputingType

public ComputingType getComputingType(FormQuestion question)

Get the computing type

Parameters:

question - the question

Returns:

the computing type

onlyForDisplay

public boolean onlyForDisplay(FormQuestion question)

Description copied from interface: FormQuestionType

Return true if the type of question is only for display.

Specified by:

onlyForDisplay in interface FormQuestionType

Parameters:

question - the question

Returns:

true if the type of question is only for display.

canBeAnsweredByUser

public boolean canBeAnsweredByUser(FormQuestion question)

Description copied from interface: FormQuestionType

Return true if the type of question can be answered by user.

Specified by:

canBeAnsweredByUser in interface FormQuestionType

Parameters:

question - the question

Returns:

true if the type of question can be answered by user.

getDefaultTitle

public I18nizableText getDefaultTitle()

Description copied from interface: FormQuestionType

Get the default title depending on type

Specified by:

getDefaultTitle in interface FormQuestionType

Returns:

the default title

saxEntryValue

public void saxEntryValue(ContentHandler contentHandler,
 FormQuestion question,
 FormEntry entry)
                   throws SAXException

Description copied from interface: FormQuestionType

Sax the entry value depending on the question type

Specified by:

saxEntryValue in interface FormQuestionType

Overrides:

saxEntryValue in class AbstractStaticFormQuestionType

Parameters:

contentHandler - the content handler

question - the question getting saxed

entry - the entry

Throws:

SAXException - exception while saxing entry

getFieldToDisableIfFormPublished

public List<String> getFieldToDisableIfFormPublished(FormQuestion question)

Description copied from interface: FormQuestionType

Get field to disable if form is published

Specified by:

getFieldToDisableIfFormPublished in interface FormQuestionType

Overrides:

getFieldToDisableIfFormPublished in class AbstractStaticFormQuestionType

Parameters:

question - the form question

Returns:

the list of field name

getJSRenderer

public String getJSRenderer(FormQuestion question)

Description copied from interface: FormQuestionType

Get the js renderer for the choice list

Specified by:

getJSRenderer in interface FormQuestionType

Parameters:

question - the question

Returns:

the js renderer

valueToJSONForClient

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

Description copied from interface: FormQuestionType

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

Specified by:

valueToJSONForClient in interface FormQuestionType

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

isCacheable

public boolean isCacheable(FormQuestion question)

Description copied from interface: FormQuestionType

Return true if the type of question can be cacheable.

Specified by:

isCacheable in interface FormQuestionType

Parameters:

question - the question

Returns:

true if the type of question can be cacheable.