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.FunctionType

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)
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 java.lang.Object

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

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

getArguments, getFullLabel

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

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

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