Package org.ametys.cms.workflow

Class SendMailToUserFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.SendMailFunction

org.ametys.cms.workflow.SendMailToUserFunction

All Implemented Interfaces:

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

public class SendMailToUserFunction
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
SendMailToUserFunction()

Method Summary

Modifier and Type	Method	Description
protected Set<UserIdentity>	_getUsers(WorkflowAwareContent content, Set<String> rights)	Get the user logins.
I18nizableText	getLabel()	Get the label for this function

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

_getContentUri, _getRequest, _getRequestUri, _sendMails, contextualize, execute, getArguments, getBodyI18nParams, getCaller, getFullLabel, getFunctionExecType, getMailBody, getMailSubject, getRecipients, getSender, getSubjectI18nParams, initialize, setPluginInfo

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

getContent, service

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

SendMailToUserFunction

public SendMailToUserFunction()

Method Details

_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

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