Package org.ametys.cms.workflow

Class CommentStepFunction

java.lang.Object

org.ametys.cms.workflow.CommentStepFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, EnhancedFunction

public class CommentStepFunction
extends Object
implements EnhancedFunction

Function setting the user comment into the step before it's stored.

Nested Class Summary

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

EnhancedFunction.FunctionArgument

Constructor Summary

Constructors

Constructor	Description
CommentStepFunction()

Method Summary

Modifier and Type	Method	Description
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
List<EnhancedFunction.FunctionArgument>	getArguments()	Get the list of accepted arguments for this function
I18nizableText	getDescription(Map<String,String> args)	Get the function descriptions depending on arguments values

Methods inherited from class java.lang.Object

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

Constructor Details

CommentStepFunction

public CommentStepFunction()

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

getArguments

public List<EnhancedFunction.FunctionArgument> getArguments()

Description copied from interface: EnhancedFunction

Get the list of accepted arguments for this function

Specified by:

getArguments in interface EnhancedFunction

Returns:

a List of argument names and associated description

getDescription

public I18nizableText getDescription(Map<String,String> args)

Description copied from interface: EnhancedFunction

Get the function descriptions depending on arguments values

Specified by:

getDescription in interface EnhancedFunction

Parameters:

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

Returns:

a description to display in workflow editor vue