Package org.ametys.plugins.forms.helper

Class AcknowledgementOfReceiptsHelper

java.lang.Object

org.ametys.plugins.forms.helper.AcknowledgementOfReceiptsHelper

All Implemented Interfaces:

Component, Serviceable

public class AcknowledgementOfReceiptsHelper
extends Object
implements Serviceable, Component

The helper for acknowledgement of receipts

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected FormDAO	_formDAO	The form DAO
protected AmetysObjectResolver	_resolver	Ametys object resolver.
static final String	REGEX_SENDER_MAIL	Pattern for senders mail
static final String	ROLE	Avalon ROLE.

Constructor Summary

Constructors

Constructor	Description
AcknowledgementOfReceiptsHelper()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAcknowledgementReceiptProperties(String formId)	Get the form properties relative to the acknowledgement of receipt
Map<String,Object>	removeEntriesReceipt(String formId)	Unset the properties relative to the acknowledgement of receipt
void	service(ServiceManager manager)
Map<String,Object>	setAcknowledgementReceiptProperties(String formId, String sender, String receiver, String subject, String body)	Set the properties relative to the acknowledgement of receipt

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.

REGEX_SENDER_MAIL

public static final String REGEX_SENDER_MAIL

Pattern for senders mail

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver.

_formDAO

protected FormDAO _formDAO

The form DAO

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Details

AcknowledgementOfReceiptsHelper

public AcknowledgementOfReceiptsHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getAcknowledgementReceiptProperties

public Map<String,Object> getAcknowledgementReceiptProperties(String formId)

Get the form properties relative to the acknowledgement of receipt

Parameters:

formId - The id of the form

Returns:

a map of the form acknowledgement of receipt properties

setAcknowledgementReceiptProperties

public Map<String,Object> setAcknowledgementReceiptProperties(String formId,
 String sender,
 String receiver,
 String subject,
 String body)

Set the properties relative to the acknowledgement of receipt

Parameters:

formId - id of the form

sender - the sender email address

receiver - name for form of question where the receiver's email address will be entered

subject - The subject for the email

body - The body of the email

Returns:

the map of results

removeEntriesReceipt

public Map<String,Object> removeEntriesReceipt(String formId)

Unset the properties relative to the acknowledgement of receipt

Parameters:

formId - The id ofthe current form

Returns:

the map of results