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 FormElementDefinitionHelper	_formElementDefinitionHelper	The form element definition helper
protected FormEntriesSearchHelper	_formEntriesSearchHelper	The form entries search helper
protected FormEntryDAO	_formEntryDAO	The form entry DAO
protected FormEntrySystemPropertyExtensionPoint	_formSystemPropertyEP	The system property extension point
protected FormWorkflowHelper	_formWorkflowHelper	The form workflow helper
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 SearcherFactory	_searcherFactory	The searcher factory
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 void	_handleComputedValues(List<FormQuestion> questions, FormEntry entry, boolean forEdition)	Handle computed values
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, String clientIP)	Creates a FormEntry.
Map<String,String>	deleteEntry(String id)	Deletes a FormEntry.
void	editFormEntry(FormEntry entry, Map<String,Object> values, View editView, boolean isJustCreated)	Edit a form entry
List<FormEntry>	getAllFormEntries(Site site)	Get all form entries
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
SearchResults<FormEntry>	searchFormEntries(String siteName, Form form, boolean onlyActiveEntries, boolean actionableOnly, boolean checkRights, Query additionalEntryFilterQuery, List<SearcherFactory.FacetDefinition> facets, List<SearcherFactory.SortDefinition> sorts, int offset, int length)	Search the form entries
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

_formSystemPropertyEP

protected FormEntrySystemPropertyExtensionPoint _formSystemPropertyEP

The system property extension point

_formElementDefinitionHelper

protected FormElementDefinitionHelper _formElementDefinitionHelper

The form element definition helper

_formEntryDAO

protected FormEntryDAO _formEntryDAO

The form entry DAO

_searcherFactory

protected SearcherFactory _searcherFactory

The searcher factory

_formWorkflowHelper

protected FormWorkflowHelper _formWorkflowHelper

The form workflow helper

_formEntriesSearchHelper

protected FormEntriesSearchHelper _formEntriesSearchHelper

The form entries search helper

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,
 String clientIP)

Creates a FormEntry.

Parameters:

form - The parent form

clientIP - The client IP address

Returns:

return the form entry

editFormEntry

public void editFormEntry(FormEntry entry,
 Map<String,Object> values,
 View editView,
 boolean isJustCreated)
                   throws Exception

Edit a form entry

Parameters:

entry - the form entry

values - the values to set

editView - the edit view

isJustCreated - true if the entry is just created before edition

Throws:

Exception - if an error occurs

_handleComputedValues

protected void _handleComputedValues(List<FormQuestion> questions,
 FormEntry entry,
 boolean forEdition)

Handle computed values

Parameters:

questions - the form questions

entry - the entry

forEdition - true to handle edition

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

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

getAllFormEntries

public List<FormEntry> getAllFormEntries(Site site)

Get all form entries

Parameters:

site - the site. Can be null to get all form entries of all sites

Returns:

the list of all form entries

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

searchFormEntries

public SearchResults<FormEntry> searchFormEntries(String siteName,
 Form form,
 boolean onlyActiveEntries,
 boolean actionableOnly,
 boolean checkRights,
 Query additionalEntryFilterQuery,
 List<SearcherFactory.FacetDefinition> facets,
 List<SearcherFactory.SortDefinition> sorts,
 int offset,
 int length)
                                           throws Exception

Search the form entries

Parameters:

siteName - the site name

form - the form

onlyActiveEntries - true to have only active entries. Active entries are used in waiting list.

actionableOnly - true to return only entry with at least one available action for the current user

checkRights - true to check rights for returned entries

additionalEntryFilterQuery - the additional entry filter query. Can be null.

facets - the list of facet

sorts - the list of sort

offset - the offset of the first result to return

length - the maximum number of results to return

Returns:

the form entries

Throws:

Exception - if an error occurred during search

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