Package org.ametys.plugins.forms.workflow

Class AbstractMailInformationHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.workflow.AbstractMailInformationHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

Direct Known Subclasses:

MailInformationHelper

public abstract class AbstractMailInformationHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper component allowing to retrieve information in order to send emails

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractMailInformationHelper.MailInfo	Class representing mail info

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected UserManager	_userManager	The user manager

Constructor Summary

Constructors

Constructor	Description
AbstractMailInformationHelper()

Method Summary

Modifier and Type	Method	Description
protected abstract List<AbstractMailInformationHelper.MailInfo>	_getMailInfos(String formId, Object entryId)	Get mail infos
Map<String,Object>	getMailInfo(String formId, Object 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

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_userManager

protected UserManager _userManager

The user manager

Constructor Details

AbstractMailInformationHelper

public AbstractMailInformationHelper()

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,
 Object 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

_getMailInfos

protected abstract List<AbstractMailInformationHelper.MailInfo> _getMailInfos(String formId,
 Object entryId)

Get mail infos

Parameters:

formId - the form id

entryId - the entry id

Returns:

the list of mail info