Package org.ametys.plugins.joboffer.workflow

Class SendMailToPersonInChargeFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.SendMailFunction

org.ametys.web.workflow.SendMailFunction

org.ametys.plugins.joboffer.workflow.SendMailToPersonInChargeFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, EnhancedFunction, PluginAware, Initializable, Contextualizable, LogEnabled, Serviceable

public class SendMailToPersonInChargeFunction
extends SendMailFunction

OS workflow function to send mail to person(s) in charge when a new application was submitted.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

AbstractWorkflowComponent.ConditionFailure

Nested classes/interfaces inherited from interface org.ametys.plugins.workflow.EnhancedFunction

EnhancedFunction.FunctionType

Field Summary

Fields inherited from class org.ametys.cms.workflow.SendMailFunction

_context, _i18nUtils, _pluginName, _rightManager, _rightsExtensionPoint, _sourceResolver, _userManager, _workflowProvider, BODY_KEY, RIGHTS_KEY, SEND_MAIL, SUBJECT_KEY

Fields inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

_contentHelper, CONTENT_KEY, HAS_CHANGED_KEY

Fields inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

_logger, _manager, CONTEXT_PARAMETERS_KEY, FAIL_CONDITIONS_KEY, RESULT_MAP_KEY, WORKFLOW_VALIDATION_KEY

Constructor Summary

Constructors

Constructor	Description
SendMailToPersonInChargeFunction()

Method Summary

Modifier and Type	Method	Description
protected String	_getToolUri(Site site)	Get the tool uri
protected Set<UserIdentity>	_getUsers(WorkflowAwareContent content, Set<String> rights)	Get the user logins.
protected void	_sendMails(String subject, String body, Set<String> recipients, String from)	Send the notification emails.
I18nizableText	getLabel()	Get the label for this function
protected String	getMailBody(String subjectI18nKey, String bodyI18nKey, User user, WorkflowAwareContent content, Map transientVars)	Get the text body of mail
protected String	getSender(Map transientVars, WorkflowAwareContent content)	Get the sender for mail
protected List<String>	getSubjectI18nParams(User user, WorkflowAwareContent content)	Get the i18n parameters of mail subject
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.web.workflow.SendMailFunction

_getContentUri, _getPage, _getSite, getBodyI18nParams

Methods inherited from class org.ametys.cms.workflow.SendMailFunction

_getContentUri, _getRequest, _getRequestUri, contextualize, execute, getArguments, getCaller, getFullLabel, getFunctionExecType, getMailSubject, getRecipients, initialize, setPluginInfo

Methods inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

getContent

Methods inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

addWorkflowError, addWorkflowWarning, enableLogging, getConditionFailures, getContextParameters, getResultsMap, getUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.workflow.EnhancedFunction

getVisibilities

Constructor Details

SendMailToPersonInChargeFunction

public SendMailToPersonInChargeFunction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SendMailFunction

Throws:

ServiceException

_getUsers

protected Set<UserIdentity> _getUsers(WorkflowAwareContent content,
 Set<String> rights)
                               throws com.opensymphony.workflow.WorkflowException

Description copied from class: SendMailFunction

Get the user logins.

Overrides:

_getUsers in class SendMailFunction

Parameters:

content - the content.

rights - the set of rights to check.

Returns:

the users.

Throws:

com.opensymphony.workflow.WorkflowException - If an error occurred

getSender

protected String getSender(Map transientVars,
 WorkflowAwareContent content)
                    throws com.opensymphony.workflow.WorkflowException

Description copied from class: SendMailFunction

Get the sender for mail

Overrides:

getSender in class SendMailFunction

Parameters:

transientVars - the transient variables

content - the content

Returns:

the sender email address

Throws:

com.opensymphony.workflow.WorkflowException - if failed to get email for sender

getSubjectI18nParams

protected List<String> getSubjectI18nParams(User user,
 WorkflowAwareContent content)

Description copied from class: SendMailFunction

Get the i18n parameters of mail subject

Overrides:

getSubjectI18nParams in class SendMailFunction

Parameters:

user - the caller

content - the content

Returns:

the i18n parameters

getMailBody

protected String getMailBody(String subjectI18nKey,
 String bodyI18nKey,
 User user,
 WorkflowAwareContent content,
 Map transientVars)

Description copied from class: SendMailFunction

Get the text body of mail

Overrides:

getMailBody in class SendMailFunction

Parameters:

subjectI18nKey - the i18n key to use for body's title

bodyI18nKey - the i18n key to use for body

user - the caller

content - the content

transientVars - the transient variables

Returns:

the text body

_getToolUri

protected String _getToolUri(Site site)

Get the tool uri

Parameters:

site - the current site

Returns:

the tool uri

_sendMails

protected void _sendMails(String subject,
 String body,
 Set<String> recipients,
 String from)

Description copied from class: SendMailFunction

Send the notification emails.

Overrides:

_sendMails in class SendMailFunction

Parameters:

subject - the e-mail subject.

body - the e-mail body.

recipients - the recipients emails address.

from - the address sending the e-mail.

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedFunction

Get the label for this function

Specified by:

getLabel in interface EnhancedFunction

Overrides:

getLabel in class SendMailFunction

Returns:

the label