Package org.ametys.plugins.forms.question

Interface FormQuestionType

All Known Implementing Classes:

AbstractFormQuestionType, AbstractStaticFormQuestionType, CheckBoxQuestionType, ChoicesListQuestionType, ComputedQuestionType, DateTimeQuestionType, FileQuestionType, MatrixQuestionType, NumberQuestionType, RichTextQuestionType, SimpleTextQuestionType, TextAreaQuestionType

public interface FormQuestionType

Interface for question's types

Method Summary

Modifier and Type	Method	Description
default boolean	canBeAnsweredByUser(FormQuestion question)	Return true if the type of question can be answered by user.
void	doAdditionalOperations(FormQuestion question, Map<String,Object> values)	Do additional operations to create or edit the question
I18nizableText	getCategory()	Get the category of question type
I18nizableText	getDefaultTitle()	Get the default title depending on type
I18nizableText	getDescription()	Get description of question type
Integer	getDisplayOrder()	Get display order of the question type
String	getDisplayXSLT()	Get the display XSLT file
Model	getEntryModel(FormQuestion question)	Get the form entry model for the question type
List<String>	getFieldToDisableIfFormPublished(FormQuestion question)	Get field to disable if form is published
String	getIconGlyph()	Get icon of question type button
String	getId()	Get id of the question type
default String	getJSConverter(FormQuestion question)	Get the js converter for the choice list
default String	getJSRenderer(FormQuestion question)	Get the js renderer for the choice list
I18nizableText	getLabel()	Get label of question type
Model	getModel()	Get the form question model
List<ClientSideElement.ScriptFile>	getScripts()	Get the scripts to import
String	getStorageType(FormQuestion question)	Get the storage type of the question type
View	getView()	Get the form question view
boolean	isQuestionConfigured(FormQuestion question)	Say if question needs more configuration to be used
default 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	validateEntryValues(FormQuestion question, Map<String,Object> values, Multimap<String,I18nizableText> errors)	Validate values to create a form entry
void	validateQuestionValues(Map<String,Object> values, Map<String,I18nizableText> errors)	Validate values to create or edit the question
default Object	valueToJSONForClient(Object value, FormQuestion question, FormEntry entry, ModelItem modelItem)	Convert the entry value into a JSON object to use client side

Method Details

getId

String getId()

Get id of the question type

Returns:

the id

getLabel

I18nizableText getLabel()

Get label of question type

Returns:

the label

getDescription

I18nizableText getDescription()

Get description of question type

Returns:

the description

getDisplayOrder

Integer getDisplayOrder()

Get display order of the question type

Returns:

the display order

getIconGlyph

String getIconGlyph()

Get icon of question type button

Returns:

the icon-glyph name

getScripts

List<ClientSideElement.ScriptFile> getScripts()

Get the scripts to import

Returns:

the list of scripts

getCategory

I18nizableText getCategory()

Get the category of question type

Returns:

the name of the category in questionTypeButtonMenu

getDisplayXSLT

String getDisplayXSLT()

Get the display XSLT file

Returns:

the display XSLT file

getView

View getView()

Get the form question view

Returns:

a view of question model

getModel

Model getModel()

Get the form question model

Returns:

the form question model

getEntryModel

Model getEntryModel(FormQuestion question)

Get the form entry model for the question type

Parameters:

question - the question

Returns:

the form entry model

getStorageType

String getStorageType(FormQuestion question)

Get the storage type of the question type

Parameters:

question - the question

Returns:

the storage type

getDefaultTitle

I18nizableText getDefaultTitle()

Get the default title depending on type

Returns:

the default title

saxAdditionalInfos

void saxAdditionalInfos(ContentHandler contentHandler,
 FormQuestion question)
                 throws SAXException

Sax additional informations for the question type

Parameters:

contentHandler - the content handler

question - the question

Throws:

SAXException - if a saxing error occurred

validateQuestionValues

void validateQuestionValues(Map<String,Object> values,
 Map<String,I18nizableText> errors)

Validate values to create or edit the question

Parameters:

values - the values

errors - the errors

validateEntryValues

void validateEntryValues(FormQuestion question,
 Map<String,Object> values,
 Multimap<String,I18nizableText> errors)

Validate values to create a form entry

Parameters:

question - the question

values - the values

errors - the errors

doAdditionalOperations

void doAdditionalOperations(FormQuestion question,
 Map<String,Object> values)

Do additional operations to create or edit the question

Parameters:

question - the question

values - the values

getFieldToDisableIfFormPublished

List<String> getFieldToDisableIfFormPublished(FormQuestion question)

Get field to disable if form is published

Parameters:

question - the form question

Returns:

the list of field name

saxEntryValue

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

Sax the entry value depending on the question type

Parameters:

contentHandler - the content handler

question - the question getting saxed

entry - the entry

Throws:

SAXException - exception while saxing entry

isQuestionConfigured

boolean isQuestionConfigured(FormQuestion question)

Say if question needs more configuration to be used

Parameters:

question - the current question

Returns:

false if question needs more configuration, true by default

getJSRenderer

default String getJSRenderer(FormQuestion question)

Get the js renderer for the choice list

Parameters:

question - the question

Returns:

the js renderer

getJSConverter

default String getJSConverter(FormQuestion question)

Get the js converter for the choice list

Parameters:

question - the question

Returns:

the js converter

valueToJSONForClient

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

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

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

onlyForDisplay

default boolean onlyForDisplay(FormQuestion question)

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

Parameters:

question - the question

Returns:

true if the type of question is only for display.

canBeAnsweredByUser

default boolean canBeAnsweredByUser(FormQuestion question)

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

Parameters:

question - the question

Returns:

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