Package org.ametys.plugins.forms.dao

Class FormDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.dao.FormDAO

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class FormDAO
extends AbstractLogEnabled
implements Serviceable, Component

The form DAO

Field Summary

Fields

Modifier and Type	Field	Description
protected CopyFormUpdaterExtensionPoint	_copyFormEP	The copy form updater extension point
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected FormDirectoryDAO	_formDirectoryDAO	The form directory DAO
protected FormEntryDAO	_formEntryDAO	The form entry DAO
protected FormPageDAO	_formPageDAO	The form page DAO
protected I18nUtils	_i18nUtils	I18n Utils
protected ObservationManager	_observationManager	Observer manager.
protected javax.jcr.Repository	_repository	The JCR repository.
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected RightManager	_rightManager	The right manager
protected ScheduleOpeningHelper	_scheduleOpeningHelper	The schedule opening helper
protected ServiceExtensionPoint	_serviceEP	The service extension point
protected SiteManager	_siteManager	The site manager
protected UserHelper	_userHelper	The user helper
protected CurrentUserProvider	_userProvider	The current user provider
protected WorkflowHelper	_workflowHelper	The workflow helper
protected ZoneDAO	_zoneDAO	The zone DAO
static final String	HANDLE_FORMS_RIGHT_ID	The right id to handle forms
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
FormDAO()

Method Summary

Modifier and Type	Method	Description
protected ZonedDateTime	_getLastSubmissionDate(List<FormEntry> entries)	Get the submission date of the last entry to the form
protected List<Map<String,Object>>	_getPagesInfos(List<SitemapElement> pages)	Get the page names
protected Set<String>	_getUserRights(Form form)	Get user rights for the given form
void	checkHandleFormRight(AmetysObject formElement)	Check rights for a form element as ametys object
Map<String,String>	copyForm(String formDirectoryId, String formId)	Copies and pastes a form.
Map<String,String>	createForm(String siteName, String parentId, String name)	Creates a Form.
Map<String,String>	deleteForm(String id)	Deletes a Form.
String	getAdminDashboardUri(String siteName)	Get the admin dashboard URI
String	getDashboardUri(String siteName)	Get the dashboard URI
List<Map<String,Object>>	getFormDisplayViews(String formId, String siteName, String language)	Get all the view available for the form display service
String	getFormFullPath(String formId)	Get the form full path
String	getFormLocale(Form form)	Get the locale to use for a given form
List<SitemapElement>	getFormPage(String formId, String siteName)	Get all the page where the form is published
Map<String,Object>	getFormProperties(String formId, boolean full, boolean withRights)	Get the form properties
Map<String,Object>	getFormProperties(Form form, boolean full, boolean withRights)	Get the form properties
List<Form>	getForms(String siteName)	Get all forms from a site
String	getFormTitle(String formId)	Get the form title
AmetysObjectIterable<ModifiableZoneItem>	getFormZoneItems(String formId, String siteName)	Get all zone items which contains the form
boolean	hasReadRightOnForm(UserIdentity userIdentity, Form form)	Check if a user have read rights on a form
boolean	hasRightAffectationRightOnForm(UserIdentity userIdentity, Form form)	Check if a user have write rights on a form
boolean	hasWriteRightOnForm(UserIdentity userIdentity, AmetysObject formElement)	Check if a user have write rights on a form element
boolean	isFormConfigured(Form form)	true if the form is well configured
Map<String,Object>	moveForm(String siteName, String id, String newParentId)	Moves a Form
Map<String,String>	renameForm(String id, String newName)	Rename a Form
void	service(ServiceManager manager)
Map<String,String>	setWorkflow(String formId, String workflowName)	Change workflow of a Form

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

HANDLE_FORMS_RIGHT_ID

public static final String HANDLE_FORMS_RIGHT_ID

The right id to handle forms

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_userProvider

protected CurrentUserProvider _userProvider

The current user provider

_i18nUtils

protected I18nUtils _i18nUtils

I18n Utils

_formDirectoryDAO

protected FormDirectoryDAO _formDirectoryDAO

The form directory DAO

_formPageDAO

protected FormPageDAO _formPageDAO

The form page DAO

_formEntryDAO

protected FormEntryDAO _formEntryDAO

The form entry DAO

_userHelper

protected UserHelper _userHelper

The user helper

_repository

protected javax.jcr.Repository _repository

The JCR repository.

_rightManager

protected RightManager _rightManager

The right manager

_serviceEP

protected ServiceExtensionPoint _serviceEP

The service extension point

_zoneDAO

protected ZoneDAO _zoneDAO

The zone DAO

_scheduleOpeningHelper

protected ScheduleOpeningHelper _scheduleOpeningHelper

The schedule opening helper

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

_siteManager

protected SiteManager _siteManager

The site manager

_observationManager

protected ObservationManager _observationManager

Observer manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

_copyFormEP

protected CopyFormUpdaterExtensionPoint _copyFormEP

The copy form updater extension point

Constructor Details

FormDAO

public FormDAO()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

hasReadRightOnForm

public boolean hasReadRightOnForm(UserIdentity userIdentity,
 Form form)

Check if a user have read rights on a form

Parameters:

userIdentity - the user

form - the form

Returns:

true if the user have read rights on a form

hasWriteRightOnForm

public boolean hasWriteRightOnForm(UserIdentity userIdentity,
 AmetysObject formElement)

Check if a user have write rights on a form element

Parameters:

userIdentity - the user

formElement - the form element

Returns:

true if the user have write rights on a form element

hasRightAffectationRightOnForm

public boolean hasRightAffectationRightOnForm(UserIdentity userIdentity,
 Form form)

Check if a user have write rights on a form

Parameters:

userIdentity - the user

form - the form

Returns:

true if the user have write rights on a form

checkHandleFormRight

public void checkHandleFormRight(AmetysObject formElement)

Check rights for a form element as ametys object

Parameters:

formElement - the form element as ametys object

getForms

public List<Form> getForms(String siteName)

Get all forms from a site

Parameters:

siteName - the site name

Returns:

the list of form

getFormProperties

public Map<String,Object> getFormProperties(String formId,
 boolean full,
 boolean withRights)

Get the form properties

Parameters:

formId - The form's id

full - true to get full information on form

withRights - true to have rights in the properties

Returns:

The form properties

getFormProperties

public Map<String,Object> getFormProperties(Form form,
 boolean full,
 boolean withRights)

Get the form properties

Parameters:

form - The form

full - true to get full information on form

withRights - true to have rights in the properties

Returns:

The form properties

getFormTitle

public String getFormTitle(String formId)

Get the form title

Parameters:

formId - the form id

Returns:

the form title

getFormFullPath

public String getFormFullPath(String formId)

Get the form full path

Parameters:

formId - the form id

Returns:

the form full path

_getUserRights

protected Set<String> _getUserRights(Form form)

Get user rights for the given form

Parameters:

form - the form

Returns:

the set of rights

createForm

public Map<String,String> createForm(String siteName,
 String parentId,
 String name)
                              throws Exception

Creates a Form.

Parameters:

siteName - The site name

parentId - The id of the parent.

name - name The desired name for the new Form

Returns:

The id of the created form

Throws:

Exception - if an error occurs during the form creation process

renameForm

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

Rename a Form

Parameters:

id - The id of the form

newName - The new name for the form

Returns:

A result map

copyForm

public Map<String,String> copyForm(String formDirectoryId,
 String formId)

Copies and pastes a form.

Parameters:

formDirectoryId - The id of the form directory target of the copy

formId - The id of the form to copy

Returns:

The results

deleteForm

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

Deletes a Form.

Parameters:

id - The id of the form to delete

Returns:

The id of the form

moveForm

public Map<String,Object> moveForm(String siteName,
 String id,
 String newParentId)

Moves a Form

Parameters:

siteName - name of the site

id - The id of the form

newParentId - The id of the new parent directory of the form.

Returns:

A result map

setWorkflow

public Map<String,String> setWorkflow(String formId,
 String workflowName)

Change workflow of a Form

Parameters:

formId - The id of the form

workflowName - The name of new workflow

Returns:

A result map

_getLastSubmissionDate

protected ZonedDateTime _getLastSubmissionDate(List<FormEntry> entries)

Get the submission date of the last entry to the form

Parameters:

entries - A list of form entry

Returns:

the date of the last submission

getFormZoneItems

public AmetysObjectIterable<ModifiableZoneItem> getFormZoneItems(String formId,
 String siteName)

Get all zone items which contains the form

Parameters:

formId - the form id

siteName - the site name

Returns:

the zone items

getFormLocale

public String getFormLocale(Form form)

Get the locale to use for a given form

Parameters:

form - the form

Returns:

the locale to use, can be null if the form is not published on a page

getFormPage

public List<SitemapElement> getFormPage(String formId,
 String siteName)

Get all the page where the form is published

Parameters:

formId - the form id

siteName - the site name

Returns:

the list of page

_getPagesInfos

protected List<Map<String,Object>> _getPagesInfos(List<SitemapElement> pages)

Get the page names

Parameters:

pages - the list of page

Returns:

the list of page name

getFormDisplayViews

public List<Map<String,Object>> getFormDisplayViews(String formId,
 String siteName,
 String language)
                                             throws Exception

Get all the view available for the form display service

Parameters:

formId - the form identifier

siteName - the site name

language - the language

Returns:

the views as json

Throws:

Exception - if an error occurred

isFormConfigured

public boolean isFormConfigured(Form form)

true if the form is well configured

Parameters:

form - the form

Returns:

true if the form is well configured

getDashboardUri

public String getDashboardUri(String siteName)

Get the dashboard URI

Parameters:

siteName - the site name

Returns:

the dashboard URI

getAdminDashboardUri

public String getAdminDashboardUri(String siteName)

Get the admin dashboard URI

Parameters:

siteName - the site name

Returns:

the admin dashboard URI