Package org.ametys.plugins.forms.dao

Class FormQuestionDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.dao.FormQuestionDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class FormQuestionDAO
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable

DAO for manipulating form questions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FormQuestionDAO.FormEntryValues	Record for entry values coming from input or from the entry

Field Summary

Fields

Modifier and Type	Field	Description
protected ChoiceSourceTypeExtensionPoint	_choiceSourceTypeExtensionPoint	The choice source type extension point
protected Context	_cocoonContext	The cocoon context
protected Context	_context	The Avalon context
protected CopyFormUpdaterExtensionPoint	_copyFormEP	The copy form updater extension point
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected FormDAO	_formDAO	The form DAO
protected FormQuestionTypeExtensionPoint	_formQuestionTypeExtensionPoint	The form question type extension point
protected I18nUtils	_i18nUtils	I18n Utils
protected JSONUtils	_jsonUtils	JSON helper
protected ObservationManager	_observationManager	Observer manager.
protected ParametersManager	_parametersManager	The parameters manager
protected AmetysObjectResolver	_resolver	Ametys object resolver.
protected RightManager	_rightManager	The right manager
protected UploadManager	_uploadManager	Manager for retrieving uploaded files
static final String	ROLE	The Avalon role
static final String	RULES_ROOT	Name for rules root jcr node

Constructor Summary

Constructors

Constructor	Description
FormQuestionDAO()

Method Summary

Modifier and Type	Method	Description
protected List<FormQuestion>	_getActiveQuestions(Form form, FormQuestionDAO.FormEntryValues entryValues, Optional<Long> currentStepId, boolean onlyWritableQuestion, boolean onlyReadableQuestion)	Get a list of the form questions not being hidden by a rule
protected UserIdentity	_getCurrentUser()	Provides the current user.
protected List<String>	_getPageTitlesWithRule(FormQuestion question)	Get the page titles having rule concerning the given question
protected List<String>	_getQuestionTitlesWithRule(FormQuestion question)	Get the question titles having rule concerning the given question
protected Set<String>	_getUserRights(FormQuestion question)	Get user rights for the given form question
Map<String,Object>	addPageRule(String id, String option, String rule, String page)	Adds a new rule to a question.
void	contextualize(Context context)
Map<String,String>	copyQuestion(String pageId, String questionId)	Copies and pastes a form question.
Map<String,Object>	createQuestion(String pageId, String typeId)	Creates a FormQuestion.
Map<String,Object>	deletePageRule(String id, String option)	Deletes a rule to a question.
Map<String,String>	deleteQuestion(String id)	Deletes a FormQuestion.
Map<String,Object>	editQuestion(String questionId, Map<String,Object> values)	Edits a FormQuestion.
Map<String,I18nizableText>	getChoiceListQuestionOptions(String questionId)	Get options from the choice list question
Map<String,Object>	getQuestionParametersDefinitions(String typeID, String formId)	Get view for question type
Map<String,Object>	getQuestionParametersValues(String questionID)	Get questions parameters values
Map<String,Object>	getQuestionProperties(String id)	Gets properties of a form question
Map<String,Object>	getQuestionProperties(FormQuestion question, boolean withRight)	Gets properties of a form question
List<FormQuestion>	getRuleFilteredQuestions(Form form, FormQuestionDAO.FormEntryValues entryValues, Optional<Long> currentStepId, boolean onlyWritableQuestion, boolean onlyReadableQuestion)	Get the list of active question depending of the form rules
Map<String,Object>	getRules(String id, int number)	Gets the page rules for a form question.
Map<String,String>	renameQuestion(String id, String newName)	Rename a FormQuestion
void	service(ServiceManager serviceManager)

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

Field Details

ROLE

public static final String ROLE

The Avalon role

RULES_ROOT

public static final String RULES_ROOT

Name for rules root jcr node

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver.

_observationManager

protected ObservationManager _observationManager

Observer manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

_uploadManager

protected UploadManager _uploadManager

Manager for retrieving uploaded files

_jsonUtils

protected JSONUtils _jsonUtils

JSON helper

_i18nUtils

protected I18nUtils _i18nUtils

I18n Utils

_formQuestionTypeExtensionPoint

protected FormQuestionTypeExtensionPoint _formQuestionTypeExtensionPoint

The form question type extension point

_parametersManager

protected ParametersManager _parametersManager

The parameters manager

_context

protected Context _context

The Avalon context

_cocoonContext

protected Context _cocoonContext

The cocoon context

_choiceSourceTypeExtensionPoint

protected ChoiceSourceTypeExtensionPoint _choiceSourceTypeExtensionPoint

The choice source type extension point

_formDAO

protected FormDAO _formDAO

The form DAO

_rightManager

protected RightManager _rightManager

The right manager

_copyFormEP

protected CopyFormUpdaterExtensionPoint _copyFormEP

The copy form updater extension point

Constructor Details

FormQuestionDAO

public FormQuestionDAO()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

_getCurrentUser

protected UserIdentity _getCurrentUser()

Provides the current user.

Returns:

the user which cannot be null.

getQuestionProperties

public Map<String,Object> getQuestionProperties(String id)

Gets properties of a form question

Parameters:

id - The id of the form question

Returns:

The properties

getQuestionProperties

public Map<String,Object> getQuestionProperties(FormQuestion question,
 boolean withRight)

Gets properties of a form question

Parameters:

question - The form question

withRight - true to have the rights in the properties

Returns:

The properties

getChoiceListQuestionOptions

public Map<String,I18nizableText> getChoiceListQuestionOptions(String questionId)

Get options from the choice list question

Parameters:

questionId - the choice list question id

Returns:

the map of option

_getUserRights

protected Set<String> _getUserRights(FormQuestion question)

Get user rights for the given form question

Parameters:

question - the form question

Returns:

the set of rights

_getQuestionTitlesWithRule

protected List<String> _getQuestionTitlesWithRule(FormQuestion question)

Get the question titles having rule concerning the given question

Parameters:

question - the question

Returns:

the list of question titles

_getPageTitlesWithRule

protected List<String> _getPageTitlesWithRule(FormQuestion question)

Get the page titles having rule concerning the given question

Parameters:

question - the question

Returns:

the list of page titles

getQuestionParametersDefinitions

public Map<String,Object> getQuestionParametersDefinitions(String typeID,
 String formId)
                                                    throws ProcessingException

Get view for question type

Parameters:

typeID - id of the question type

formId - id of the form

Returns:

the view parsed in json for configurableFormPanel

Throws:

ProcessingException - error while parsing view to json

getQuestionParametersValues

public Map<String,Object> getQuestionParametersValues(String questionID)

Get questions parameters values

Parameters:

questionID - id of current question

Returns:

map of question parameters value

createQuestion

public Map<String,Object> createQuestion(String pageId,
 String typeId)

Creates a FormQuestion.

Parameters:

pageId - id of current page

typeId - id of FormQuestionType

Returns:

The id of the created form question, the id of the page and the id of the form

renameQuestion

public Map<String,String> renameQuestion(String id,
 String newName)

Rename a FormQuestion

Parameters:

id - The id of the question

newName - The new name of the question

Returns:

A result map

editQuestion

public Map<String,Object> editQuestion(String questionId,
 Map<String,Object> values)

Edits a FormQuestion.

Parameters:

questionId - id of current question

values - The question's values

Returns:

The id of the edited form question, the id of the page and the id of the form

deleteQuestion

public Map<String,String> deleteQuestion(String id)

Deletes a FormQuestion.

Parameters:

id - The id of the form question to delete

Returns:

The id of the form question, the id of the page and the id of the form

copyQuestion

public Map<String,String> copyQuestion(String pageId,
 String questionId)

Copies and pastes a form question.

Parameters:

pageId - The id of the page, target of the copy

questionId - The id of the question to copy

Returns:

The id of the created question, the id of the page and the id of the form

getRules

public Map<String,Object> getRules(String id,
 int number)
                            throws Exception

Gets the page rules for a form question.

Parameters:

id - The id of the form question.

number - The question number

Returns:

The rules

Throws:

Exception - error while getting choice options

addPageRule

public Map<String,Object> addPageRule(String id,
 String option,
 String rule,
 String page)

Adds a new rule to a question.

Parameters:

id - The question id

option - The option

rule - The rule type

page - The page to jump or skip

Returns:

An empty map, or an error

deletePageRule

public Map<String,Object> deletePageRule(String id,
 String option)

Deletes a rule to a question.

Parameters:

id - The question id

option - The option to delete

Returns:

An empty map

getRuleFilteredQuestions

public List<FormQuestion> getRuleFilteredQuestions(Form form,
 FormQuestionDAO.FormEntryValues entryValues,
 Optional<Long> currentStepId,
 boolean onlyWritableQuestion,
 boolean onlyReadableQuestion)

Get the list of active question depending of the form rules

Parameters:

form - the form

entryValues - the entry values to compute rules

currentStepId - the current step id. Can be empty if the form has no workflow

onlyWritableQuestion - true to have only writable question

onlyReadableQuestion - true to have only readable question

Returns:

the list of active question depending of the form rules

_getActiveQuestions

protected List<FormQuestion> _getActiveQuestions(Form form,
 FormQuestionDAO.FormEntryValues entryValues,
 Optional<Long> currentStepId,
 boolean onlyWritableQuestion,
 boolean onlyReadableQuestion)

Get a list of the form questions not being hidden by a rule

Parameters:

form - the current form

entryValues - the entry values

currentStepId - current step of the entry. Can be empty if the form has no workflow

onlyWritableQuestion - true to have only writable question

onlyReadableQuestion - true to have only readable question

Returns:

a list of visible questions