Package org.ametys.plugins.forms.dao

Class FormEntryDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.dao.FormEntryDAO

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class FormEntryDAO
extends AbstractLogEnabled
implements Serviceable, Component

Form entry DAO.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FormEntryDAO.Sort	Record representing a sort with form attribute name and direction

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected LimitedEntriesHelper	_handleLimitedEntriesHelper	The handling limited entries helper
protected ObservationManager	_observationManager	Observer manager.
protected ParametersManager	_parametersManager	The parameters manager
protected AmetysObjectResolver	_resolver	Ametys object resolver.
protected RightManager	_rightManager	The rights manager
protected SystemPropertyExtensionPoint	_systemPropertyEP	The system property extension point
protected UserManager	_userManager	The user manager
protected WorkflowProvider	_workflowProvider	The current user provider
static final String	DELETE_FORMS_ENTRIES_RIGHT_ID	The right id to delete form entries
static final String	ENTRIES_ROOT	Name for entries root jcr node
static final String	HANDLE_FORMS_ENTRIES_RIGHT_ID	The right id to consult form entries
static final String	ROLE	The Avalon role name.

Constructor Summary

Constructors

Constructor	Description
FormEntryDAO()

Method Summary

Modifier and Type	Method	Description
protected List<Map<String,Object>>	_getColumns(Form form)	Get the columns for search form entries
protected Map<String,Object>	_getCriteria(Form form)	Get criteria to search form entries
protected Set<String>	_getUserRights(FormEntry entry)	Get user rights for the given form entry
protected boolean	_isSortable(FormQuestion question)	true if the column link to the question is sortable
void	checkHandleDataRight(AmetysObject formElement)	Check handle data right for a form element as ametys object
Map<String,Object>	clearEntries(String id)	Delete all entries of a form
FormEntry	createEntry(Form form)	Creates a FormEntry.
Map<String,String>	deleteEntry(String id)	Deletes a FormEntry.
Long	getCurrentStepId(FormEntry entry)	Retrieves the current step id of the form entry
List<FormEntry>	getFormEntries(Form form, boolean onlyActiveEntries, List<FormEntryDAO.Sort> sorts)	Get the form entries
List<FormEntry>	getFormEntries(Form form, boolean onlyActiveEntries, Expression additionalEntryFilterExpr, List<FormEntryDAO.Sort> sorts)	Get the form entries
List<Map<String,String>>	getFormEntriesUsers(String formId)	Get all users who answer to the form as JSON
Model	getFormEntryModel(Form form)	Get the form entry model
Map<String,Object>	getFormEntryProperties(String id)	Gets properties of a form entry
Map<String,Object>	getFormEntryProperties(FormEntry entry)	Gets properties of a form entry
Map<String,Object>	getSearchModelConfiguration(String formId)	Get the search model configuration to search form entries
boolean	hasHandleDataRightOnForm(UserIdentity userIdentity, AmetysObject formElement)	Check if a user have handle data right on a form element as ametys object
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 name.

ENTRIES_ROOT

public static final String ENTRIES_ROOT

Name for entries root jcr node

See Also:

• Constant Field Values

HANDLE_FORMS_ENTRIES_RIGHT_ID

public static final String HANDLE_FORMS_ENTRIES_RIGHT_ID

The right id to consult form entries

See Also:

• Constant Field Values

DELETE_FORMS_ENTRIES_RIGHT_ID

public static final String DELETE_FORMS_ENTRIES_RIGHT_ID

The right id to delete form entries

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver.

_parametersManager

protected ParametersManager _parametersManager

The parameters manager

_observationManager

protected ObservationManager _observationManager

Observer manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

_handleLimitedEntriesHelper

protected LimitedEntriesHelper _handleLimitedEntriesHelper

The handling limited entries helper

_rightManager

protected RightManager _rightManager

The rights manager

_workflowProvider

protected WorkflowProvider _workflowProvider

The current user provider

_userManager

protected UserManager _userManager

The user manager

_systemPropertyEP

protected SystemPropertyExtensionPoint _systemPropertyEP

The system property extension point

Constructor Details

FormEntryDAO

public FormEntryDAO()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

hasHandleDataRightOnForm

public boolean hasHandleDataRightOnForm(UserIdentity userIdentity,
 AmetysObject formElement)

Check if a user have handle data right on a form element as ametys object

Parameters:

userIdentity - the user

formElement - the form element

Returns:

true if the user handle data right for a form element

checkHandleDataRight

public void checkHandleDataRight(AmetysObject formElement)

Check handle data right for a form element as ametys object

Parameters:

formElement - the form element as ametys object

getFormEntryProperties

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

Gets properties of a form entry

Parameters:

id - The id of the form entry

Returns:

The properties

getFormEntryProperties

public Map<String,Object> getFormEntryProperties(FormEntry entry)

Gets properties of a form entry

Parameters:

entry - The form entry

Returns:

The properties

_getUserRights

protected Set<String> _getUserRights(FormEntry entry)

Get user rights for the given form entry

Parameters:

entry - the form entry

Returns:

the set of rights

createEntry

public FormEntry createEntry(Form form)

Creates a FormEntry.

Parameters:

form - The parent form

Returns:

return the form entry

getSearchModelConfiguration

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

Get the search model configuration to search form entries

Parameters:

formId - the identifier of form

Returns:

The search model configuration

Throws:

ProcessingException - If an error occurred

_getCriteria

protected Map<String,Object> _getCriteria(Form form)

Get criteria to search form entries

Parameters:

form - the form

Returns:

the criteria as JSON

_getColumns

protected List<Map<String,Object>> _getColumns(Form form)
                                        throws ProcessingException

Get the columns for search form entries

Parameters:

form - the form

Returns:

the columns as JSON

Throws:

ProcessingException - if an error occurred

_isSortable

protected boolean _isSortable(FormQuestion question)

true if the column link to the question is sortable

Parameters:

question - the question

Returns:

true if the column link to the question is sortable

deleteEntry

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

Deletes a FormEntry.

Parameters:

id - The id of the form entry to delete

Returns:

The entry data

clearEntries

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

Delete all entries of a form

Parameters:

id - The id of the form

Returns:

the deleted entries data

getCurrentStepId

public Long getCurrentStepId(FormEntry entry)
                      throws AmetysRepositoryException

Retrieves the current step id of the form entry

Parameters:

entry - The form entry

Returns:

the current step id

Throws:

AmetysRepositoryException - if an error occurs.

getFormEntryModel

public Model getFormEntryModel(Form form)

Get the form entry model

Parameters:

form - the form

Returns:

the form entry model

getFormEntries

public List<FormEntry> getFormEntries(Form form,
 boolean onlyActiveEntries,
 List<FormEntryDAO.Sort> sorts)

Get the form entries

Parameters:

form - the form

onlyActiveEntries - true to have only active entries

sorts - the list of sort

Returns:

the form entries

getFormEntries

public List<FormEntry> getFormEntries(Form form,
 boolean onlyActiveEntries,
 Expression additionalEntryFilterExpr,
 List<FormEntryDAO.Sort> sorts)

Get the form entries

Parameters:

form - the form

onlyActiveEntries - true to have only active entries

additionalEntryFilterExpr - the additional entry filter expression. Can be null.

sorts - the list of sort

Returns:

the form entries

getFormEntriesUsers

public List<Map<String,String>> getFormEntriesUsers(String formId)

Get all users who answer to the form as JSON

Parameters:

formId - the form id

Returns:

all users as JSON