Package org.ametys.plugins.ugc.workflow

Class SendMailToCreatorFunction

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.ugc.workflow.SendMailToCreatorFunction

All Implemented Interfaces:

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

public class SendMailToCreatorFunction
extends SendMailFunction

OS workflow function to send mail after an action is triggered.

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
SendMailToCreatorFunction()

Method Summary

Modifier and Type	Method	Description
protected List<String>	getBodyI18nParams(User user, WorkflowAwareContent content)	Get the i18n parameters of mail body text
I18nizableText	getLabel()	Get the label for this function
protected Set<String>	getRecipients(Map transientVars, WorkflowAwareContent content, Set<String> rights)	Get the recipients
protected String	getSender(Map transientVars, WorkflowAwareContent content)	Get the sender for mail
void	service(ServiceManager smanager)

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

_getContentUri, _getPage, _getRequestUri, _getSite, getMailBody, getSubjectI18nParams

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

_getContentUri, _getRequest, _getUsers, _sendMails, contextualize, execute, getArguments, getCaller, getFullLabel, getFunctionExecType, getMailSubject, 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

SendMailToCreatorFunction

public SendMailToCreatorFunction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SendMailFunction

Throws:

ServiceException

getRecipients

protected Set<String> getRecipients(Map transientVars,
 WorkflowAwareContent content,
 Set<String> rights)
                             throws com.opensymphony.workflow.WorkflowException

Description copied from class: SendMailFunction

Get the recipients

Overrides:

getRecipients in class SendMailFunction

Parameters:

transientVars - the transient variables

content - the content.

rights - the set of rights to check.

Returns:

the recipients.

Throws:

com.opensymphony.workflow.WorkflowException - If failed to get recipients

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

getBodyI18nParams

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

Description copied from class: SendMailFunction

Get the i18n parameters of mail body text

Overrides:

getBodyI18nParams in class SendMailFunction

Parameters:

user - the caller

content - the content

Returns:

the i18n parameters

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