Package org.ametys.plugins.forms.workflow

Class SendMailFunction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.forms.workflow.SendMailFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, EnhancedFunction, Component, LogEnabled

public class SendMailFunction
extends AbstractLogEnabled
implements Component, EnhancedFunction

OS workflow function to send mail after an action is triggered. The author of a form entry is also notified if the receipt is set

Nested Class Summary

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

EnhancedFunction.FunctionType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BODY	Body of the email
static final String	RECIPIENT	Recipient of the email
static final String	SEND_MAIL	Actually send the email ?
static final String	SENDER	Sender of the email
static final String	SUBJECT	Subject of the email

Constructor Summary

Constructors

Constructor	Description
SendMailFunction()

Method Summary

Modifier and Type	Method	Description
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
I18nizableText	getFullLabel(Map<String,String> argumentsValues)	Get the function label depending on arguments values
EnhancedFunction.FunctionType	getFunctionExecType()	Return the type for the function
I18nizableText	getLabel()	Get the label for this function
List<WorkflowHelper.WorkflowVisibility>	getVisibilities()	Get the function's visibilities depending on rights

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

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

getArguments

Field Details

SEND_MAIL

public static final String SEND_MAIL

Actually send the email ?

See Also:

• Constant Field Values

SENDER

public static final String SENDER

Sender of the email

See Also:

• Constant Field Values

RECIPIENT

public static final String RECIPIENT

Recipient of the email

See Also:

• Constant Field Values

SUBJECT

public static final String SUBJECT

Subject of the email

See Also:

• Constant Field Values

BODY

public static final String BODY

Body of the email

See Also:

• Constant Field Values

Constructor Details

SendMailFunction

public SendMailFunction()

Method Details

execute

public void execute(Map transientVars,
 Map args,
 com.opensymphony.module.propertyset.PropertySet ps)
             throws com.opensymphony.workflow.WorkflowException

Specified by:

execute in interface com.opensymphony.workflow.FunctionProvider

Throws:

com.opensymphony.workflow.WorkflowException

getFunctionExecType

public EnhancedFunction.FunctionType getFunctionExecType()

Description copied from interface: EnhancedFunction

Return the type for the function

Specified by:

getFunctionExecType in interface EnhancedFunction

Returns:

the type 's code

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedFunction

Get the label for this function

Specified by:

getLabel in interface EnhancedFunction

Returns:

the label

getFullLabel

public I18nizableText getFullLabel(Map<String,String> argumentsValues)

Description copied from interface: EnhancedFunction

Get the function label depending on arguments values

Specified by:

getFullLabel in interface EnhancedFunction

Parameters:

argumentsValues - a map of the arguments with their values in current workflow

Returns:

a label to display in workflow editor vue

getVisibilities

public List<WorkflowHelper.WorkflowVisibility> getVisibilities()

Description copied from interface: EnhancedFunction

Get the function's visibilities depending on rights

Specified by:

getVisibilities in interface EnhancedFunction

Returns:

a list of all the allowed right profiles