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

Interface MandatoryAwareFormQuestionType

All Known Implementing Classes:

AbstractFormQuestionType, CheckBoxQuestionType, ChoicesListQuestionType, DateTimeQuestionType, FileQuestionType, MatrixQuestionType, NumberQuestionType, SimpleTextQuestionType, TextAreaQuestionType

public interface MandatoryAwareFormQuestionType

Provide all the necessary method to make a question type required or not

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_MANDATORY	Constant for mandatory attribute.

Method Summary

Modifier and Type	Method	Description
default ModelItem	getMandatoryModelItem()	Get the model item to add to the model items return by the method FormQuestionType.getModel
default Validator	getMandatoryValidator(FormQuestion question)	Create a validator that should be added to the element definition return by FormQuestionType.getEntryModel
default ViewElement	getMandatoryViewElement(Model model)	Create a view element to add in the view elements returned by FormQuestionType.getView
default boolean	isMandatory(FormQuestion question)	Check if the question is actually mandatory

Field Details

ATTRIBUTE_MANDATORY

static final String ATTRIBUTE_MANDATORY

Constant for mandatory attribute.

See Also:

• Constant Field Values

Method Details

getMandatoryModelItem

default ModelItem getMandatoryModelItem()

Get the model item to add to the model items return by the method FormQuestionType.getModel

Returns:

the model item

getMandatoryViewElement

default ViewElement getMandatoryViewElement(Model model)

Create a view element to add in the view elements returned by FormQuestionType.getView

Parameters:

model - the model link to the view

Returns:

a view element

getMandatoryValidator

default Validator getMandatoryValidator(FormQuestion question)

Create a validator that should be added to the element definition return by FormQuestionType.getEntryModel

Parameters:

question - the question

Returns:

a validator

isMandatory

default boolean isMandatory(FormQuestion question)

Check if the question is actually mandatory

Parameters:

question - the question to check

Returns:

true if the question is mandatory