Package org.ametys.plugins.forms.dao

Class FormPageDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.dao.FormPageDAO

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class FormPageDAO
extends AbstractLogEnabled
implements Serviceable, Component

DAO for manipulating form pages

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected FormDAO	_formDAO	The form DAO
protected FormQuestionDAO	_formQuestionDAO	The form question DAO
protected I18nUtils	_i18nUtils	I18n Utils
protected ObservationManager	_observationManager	Observer manager.
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected RightManager	_rightManager	The right manager
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
FormPageDAO()

Method Summary

Modifier and Type	Method	Description
protected UserIdentity	_getCurrentUser()	Provides the current user.
protected Set<String>	_getUserRights(FormPage page)	Get user rights for the given form page
Map<String,Object>	addRule(String id, String rule, String page)	Adds a a new rule to a page.
Map<String,String>	copyPage(String formId, String pageId)	Copies and pastes a form page.
Map<String,String>	createPage(String parentId, String name)	Creates a FormPage.
Map<String,String>	deletePage(String id)	Deletes a FormPage.
Map<String,Object>	deleteRule(String id)	Deletes a rule to a page
Map<String,Object>	getBranches(String pageId)	Gets the branches for a form page.
List<Map<String,Object>>	getChildPages(String formId)	Gets all pages for given parent
List<String>	getIdsOfPath(String id)	Gets the ids of the path elements of a form component, i.e.
Map<String,Object>	getPageProperties(String pageId)	Get the page's properties
Map<String,Object>	getPageProperties(FormPage page, boolean withRights)	Get the page's properties
protected Form	getParentForm(JCRAmetysObject obj)	Get the form containing the given object.
Map<String,Object>	getRule(String id)	Gets the rule for a form page.
boolean	isLastPage(String id)	Determines if a page is the last of form's pages.
Map<String,String>	moveObject(String id, String oldParent, String newParent, long index)	Moves an element of the form.
Map<String,String>	renamePage(String id, String newName)	Rename a FormPage
void	service(ServiceManager manager)

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

_observationManager

protected ObservationManager _observationManager

Observer manager.

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

_formQuestionDAO

protected FormQuestionDAO _formQuestionDAO

The form question DAO

_i18nUtils

protected I18nUtils _i18nUtils

I18n Utils

_formDAO

protected FormDAO _formDAO

The form DAO

_rightManager

protected RightManager _rightManager

The right manager

Constructor Details

FormPageDAO

public FormPageDAO()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

createPage

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

Creates a FormPage.

Parameters:

parentId - The id of the parent.

name - The desired name for the new FormPage

Returns:

The id of the created form page

Throws:

Exception - if an error occurs during the form creation process

renamePage

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

Rename a FormPage

Parameters:

id - The id of the page

newName - The new name of the page

Returns:

A result map

deletePage

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

Deletes a FormPage.

Parameters:

id - The id of the page to delete

Returns:

The id of the page

copyPage

public Map<String,String> copyPage(String formId,
 String pageId)

Copies and pastes a form page.

Parameters:

formId - The id of the form, target of the copy

pageId - The id of the page to copy

Returns:

The id of the created page

moveObject

public Map<String,String> moveObject(String id,
 String oldParent,
 String newParent,
 long index)
                              throws Exception

Moves an element of the form.

Parameters:

id - The id of the element to move.

oldParent - The id of the element's parent.

newParent - The id of the new element's parent.

index - The index where to move. null to place the element at the end.

Returns:

A map with the ids of the element, the old parent and the new parent

Throws:

Exception - if an error occurs when moving an element of the form

getPageProperties

public Map<String,Object> getPageProperties(String pageId)

Get the page's properties

Parameters:

pageId - The form page's id

Returns:

The page properties

getPageProperties

public Map<String,Object> getPageProperties(FormPage page,
 boolean withRights)

Get the page's properties

Parameters:

page - The form page

withRights - true to have the rights in the properties

Returns:

The page properties

_getUserRights

protected Set<String> _getUserRights(FormPage page)

Get user rights for the given form page

Parameters:

page - the form page

Returns:

the set of rights

getIdsOfPath

public List<String> getIdsOfPath(String id)

Gets the ids of the path elements of a form component, i.e. the parent ids.
For instance, if the page path is 'a/b/c', then the result list will be ["id-of-a", "id-of-b", "id-of-c"]

Parameters:

id - The id of the form component

Returns:

the ids of the path elements of a form

getChildPages

public List<Map<String,Object>> getChildPages(String formId)

Gets all pages for given parent

Parameters:

formId - The id of the Form, defining the context from which getting children

Returns:

all forms for given parent

getParentForm

protected Form getParentForm(JCRAmetysObject obj)

Get the form containing the given object.

Parameters:

obj - the object.

Returns:

the parent Form.

isLastPage

public boolean isLastPage(String id)

Determines if a page is the last of form's pages.

Parameters:

id - The page id

Returns:

True if the page is the last one.

getBranches

public Map<String,Object> getBranches(String pageId)

Gets the branches for a form page.

Parameters:

pageId - The id of the form page.

Returns:

The branches

getRule

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

Gets the rule for a form page.

Parameters:

id - The id of the form page.

Returns:

The rule, or null

addRule

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

Adds a a new rule to a page.

Parameters:

id - The id of the page

rule - The rule type

page - The page to jump or skip

Returns:

An empty map

deleteRule

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

Deletes a rule to a page

Parameters:

id - The id of the page

Returns:

An empty map

_getCurrentUser

protected UserIdentity _getCurrentUser()

Provides the current user.

Returns:

the user which cannot be null.