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

Interface ConfidentialAwareQuestionType

All Known Implementing Classes:

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

public interface ConfidentialAwareQuestionType

Provide the necessary method make a form question type aware of confidentiality. Every implementation should make sure that the result of the different provided method are used. The value of FormQuestion.ATTRIBUTE_CONFIDENTIALITY should also be included in the result of the getFieldToDisableIfFormPublished method

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_CONFIDENTIALITY	Constant for confidentiality on field

Method Summary

Modifier and Type	Method	Description
default ModelItem	getConfidentialityModelItem()	Provide an item that should be included in the model returned by the FormQuestion._getModelItems method
default ViewItem	getConfidentialityViewElement(Model model)	Provide a view item to include in one of the tab return by the FormQuestion.getTabs method.
static boolean	isConfidential(FormQuestion formQuestion)	Helper method to determine if a question is confidential

Field Details

ATTRIBUTE_CONFIDENTIALITY

static final String ATTRIBUTE_CONFIDENTIALITY

Constant for confidentiality on field

See Also:

• Constant Field Values

Method Details

getConfidentialityModelItem

default ModelItem getConfidentialityModelItem()

Provide an item that should be included in the model returned by the FormQuestion._getModelItems method

Returns:

the model item to include

getConfidentialityViewElement

default ViewItem getConfidentialityViewElement(Model model)

Provide a view item to include in one of the tab return by the FormQuestion.getTabs method. It is preferred to include this item in the advanced tab.

Parameters:

model - the model of the question type

Returns:

the view item to include

isConfidential

static boolean isConfidential(FormQuestion formQuestion)

Helper method to determine if a question is confidential

Parameters:

formQuestion - the question

Returns:

true if the question is confidential