Package org.ametys.plugins.forms.helper

Class FormInvitationsHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.helper.FormInvitationsHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class FormInvitationsHelper
extends AbstractLogEnabled
implements Serviceable, Component

The helper to schedule opening of form

Field Summary

Fields

Modifier and Type	Field	Description
protected FormDAO	_formDAO	The form DAO
protected I18nUtils	_i18nUtils	The i18n utils
protected LimitedEntriesHelper	_limitedEntriesHelper	The limited entries helper
protected AmetysObjectResolver	_resolver	Ametys object resolver.
protected RightManager	_rightManager	The right manager
protected SiteManager	_siteManager	The site manager
protected UserManager	_userManager	The users manager
static final String	ROLE	Avalon ROLE.

Constructor Summary

Constructors

Constructor	Description
FormInvitationsHelper()

Method Summary

Modifier and Type	Method	Description
protected String	_getFormURI(String formId, String siteName, String language)	Get the form page uri
protected String	_getMailBody(String formId, String message, String siteName, String language)	Get the email body
protected String	_getMailSubject(String language)	Get the email subject
protected List<User>	_getUsersToInvite(Form form)	Get users to invite to the form (user with mail and who are not answered yet to the form)
int	getNbOfUsersToInvite(String formId)	Get users to invite to the form (user with mail and who are not answered yet to the form)
Map<String,Object>	sendInvitations(String formId, String message, String siteName, String language)	Sends invitations emails.
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

Avalon ROLE.

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver.

_userManager

protected UserManager _userManager

The users manager

_siteManager

protected SiteManager _siteManager

The site manager

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_rightManager

protected RightManager _rightManager

The right manager

_limitedEntriesHelper

protected LimitedEntriesHelper _limitedEntriesHelper

The limited entries helper

_formDAO

protected FormDAO _formDAO

The form DAO

Constructor Details

FormInvitationsHelper

public FormInvitationsHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

sendInvitations

public Map<String,Object> sendInvitations(String formId,
 String message,
 String siteName,
 String language)

Sends invitations emails.

Parameters:

formId - The id of the form.

message - The message content.

siteName - The site name.

language - the language

Returns:

An empty map

_getUsersToInvite

protected List<User> _getUsersToInvite(Form form)

Get users to invite to the form (user with mail and who are not answered yet to the form)

Parameters:

form - the form

Returns:

the users to invite

getNbOfUsersToInvite

public int getNbOfUsersToInvite(String formId)

Get users to invite to the form (user with mail and who are not answered yet to the form)

Parameters:

formId - The id of the form.

Returns:

The number of users to invite

_getMailSubject

protected String _getMailSubject(String language)

Get the email subject

Parameters:

language - the language

Returns:

The subject

_getMailBody

protected String _getMailBody(String formId,
 String message,
 String siteName,
 String language)

Get the email body

Parameters:

formId - The form id

message - The message

siteName - The site name

language - the language

Returns:

The text body

_getFormURI

protected String _getFormURI(String formId,
 String siteName,
 String language)

Get the form page uri

Parameters:

formId - The form id

siteName - The site name

language - the language

Returns:

The survey absolute uri