Package org.ametys.plugins.forms.actions

Class AbstractProcessFormAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.plugins.forms.actions.AbstractProcessFormAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

Direct Known Subclasses:

EditFormEntryAction, ProcessFormAction

public abstract class AbstractProcessFormAction
extends ServiceableAction

Abstract action to process form entry inputs

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected FormEntryDAO	_entryDAO	The form entry DAO
protected FOAmetysObjectCreationHelper	_foAmetysObjectCreationHelper	The FO ametys object creation helper
protected FormDAO	_formDAO	The form DAO
protected FormQuestionDAO	_formQuestionDAO	The form question DAO
protected FormWorkflowHelper	_formWorkflowHelper	The form workflow helper
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected RightManager	_rightManager	The right manager

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractProcessFormAction()

Method Summary

Modifier and Type	Method	Description
protected void	_adaptFormValuesForChoiceList(Form form, Map<String,Object> formInputValues)	Remove empty value for choice list because empty value is an other value
protected void	_adaptFormValuesForFile(Request request, Form form, Map<String,Object> values)	Adapt file question values to handle untouched file input.
protected View	_getRuleFilteredEntryView(Request request, Form form, View entryView, FormQuestionDAO.FormEntryValues entryValues, Optional<Long> currentStepId)	Get a view without elements hidden by a rule
protected abstract List<FormQuestion>	_getRuleFilteredQuestions(Request request, Form form, FormQuestionDAO.FormEntryValues entryValues, Optional<Long> currentStepId)	Get the list of active question depending of the form rules
protected void	_handleComputedValues(List<FormQuestion> questions, FormEntry entry, boolean forEdition)	Handle computed values
protected Multimap<String,I18nizableText>	editFormEntryValues(Request request, FormEntry entry, Optional<Long> currentStepId, Map<String,Object> additionalParameters, boolean isCreated)	Edit form entry values with form inputs and validate them.
void	service(ServiceManager smanager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.cocoon.acting.Action

act

Field Details

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_foAmetysObjectCreationHelper

protected FOAmetysObjectCreationHelper _foAmetysObjectCreationHelper

The FO ametys object creation helper

_formDAO

protected FormDAO _formDAO

The form DAO

_entryDAO

protected FormEntryDAO _entryDAO

The form entry DAO

_formQuestionDAO

protected FormQuestionDAO _formQuestionDAO

The form question DAO

_rightManager

protected RightManager _rightManager

The right manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_formWorkflowHelper

protected FormWorkflowHelper _formWorkflowHelper

The form workflow helper

Constructor Details

AbstractProcessFormAction

public AbstractProcessFormAction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

_adaptFormValuesForChoiceList

protected void _adaptFormValuesForChoiceList(Form form,
 Map<String,Object> formInputValues)

Remove empty value for choice list because empty value is an other value

Parameters:

form - the form

formInputValues - the form inputs to change

_adaptFormValuesForFile

protected void _adaptFormValuesForFile(Request request,
 Form form,
 Map<String,Object> values)

Adapt file question values to handle untouched file input.

Parameters:

request - the request containing form parameters

form - the form containing questions

values - the form values to adapt

_getRuleFilteredEntryView

protected View _getRuleFilteredEntryView(Request request,
 Form form,
 View entryView,
 FormQuestionDAO.FormEntryValues entryValues,
 Optional<Long> currentStepId)

Get a view without elements hidden by a rule

Parameters:

request - the request

form - The current form

entryView - The entry view with possibly unwanted viewItems

entryValues - The entry values

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

Returns:

a view with filtered items

_getRuleFilteredQuestions

protected abstract List<FormQuestion> _getRuleFilteredQuestions(Request request,
 Form form,
 FormQuestionDAO.FormEntryValues entryValues,
 Optional<Long> currentStepId)

Get the list of active question depending of the form rules

Parameters:

request - the request

form - the form

entryValues - the entry values to compute rules

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

Returns:

the list of active question depending of the form rules

_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

editFormEntryValues

protected Multimap<String,I18nizableText> editFormEntryValues(Request request,
 FormEntry entry,
 Optional<Long> currentStepId,
 Map<String,Object> additionalParameters,
 boolean isCreated)
                                                       throws Exception

Edit form entry values with form inputs and validate them. If no error is found, values are saved in the entry and the form is saved.

Parameters:

request - the request containing form parameters

entry - the form entry to edit

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

additionalParameters - additional parameters to provide to question type validation

isCreated - true if the entry is being created, false if it is an edition.

Returns:

the map of errors

Throws:

Exception - if an error occurred