Package org.ametys.plugins.forms.workflow

Class MailInformationHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.workflow.MailInformationHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class MailInformationHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper component allowing to retrieve information in order to send emails

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected static final Pattern	_EMAIL_PATTERN	The email validation pattern.
protected FormPropertiesManager	_formPropertiesManager	The manager for the JCR representation of forms
protected FormTableManager	_formTableManager	The manager for the form entries
protected UserManager	_userManager	The user manager
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
MailInformationHelper()

Method Summary

Modifier and Type	Method	Description
protected List<Map<String,String>>	_getAvailableRecipients(UserEntry formEntry)	Get the available recipients from the form entries to propose recipients.
protected UserEntry	_getFormEntry(String formId, Integer entryId)	Get the form entry from form identifier and entry identifier.
protected Map<String,Object>	_getSender()	Get the sender filled into the dialog to send informations to claimant by email about his form entry status.
Map<String,Object>	getMailInfo(String formId, Integer entryId)	Get information on the given entry of the given form
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

_EMAIL_PATTERN

protected static final Pattern _EMAIL_PATTERN

The email validation pattern.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_userManager

protected UserManager _userManager

The user manager

_formPropertiesManager

protected FormPropertiesManager _formPropertiesManager

The manager for the JCR representation of forms

_formTableManager

protected FormTableManager _formTableManager

The manager for the form entries

Constructor Details

MailInformationHelper

public MailInformationHelper()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getMailInfo

public Map<String,Object> getMailInfo(String formId,
 Integer entryId)

Get information on the given entry of the given form

Parameters:

formId - the id of the form

entryId - the id of the entry

Returns:

a map of information on the current user and on the email fields filled in the entry

_getSender

protected Map<String,Object> _getSender()

Get the sender filled into the dialog to send informations to claimant by email about his form entry status.

Returns:

the sender

_getAvailableRecipients

protected List<Map<String,String>> _getAvailableRecipients(UserEntry formEntry)

Get the available recipients from the form entries to propose recipients.

Parameters:

formEntry - The form entry

Returns:

the list of available recipients

_getFormEntry

protected UserEntry _getFormEntry(String formId,
 Integer entryId)

Get the form entry from form identifier and entry identifier.

Parameters:

formId - The form id

entryId - The entry id

Returns:

the form entry or throw a IllegalArgumentException if it doesn't exist.