Package org.ametys.plugins.forms.workflow

Class ActiveEntryFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.plugins.forms.workflow.ActiveEntryFunction

All Implemented Interfaces:

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

public class ActiveEntryFunction
extends AbstractWorkflowComponent
implements EnhancedFunction

OS workflow function to active the entry

Nested Class Summary

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

EnhancedFunction.FunctionArgument

Field Summary

Fields

Modifier and Type	Field	Description
protected FormMailHelper	_formMailHelper	The form mail helper
protected LimitedEntriesHelper	_limitedEntriesHelper	The limited entries helper

Fields inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

_logger, _manager, CONTEXT_PARAMETERS_KEY, FAIL_CONDITIONS_KEY, RESULT_MAP_KEY, WORKFLOW_ERRORS_KEY, WORKFLOW_WARNS_KEY

Constructor Summary

Constructors

Constructor	Description
ActiveEntryFunction()

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
void	service(ServiceManager manager)

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

Field Details

_limitedEntriesHelper

protected LimitedEntriesHelper _limitedEntriesHelper

The limited entries helper

_formMailHelper

protected FormMailHelper _formMailHelper

The form mail helper

Constructor Details

ActiveEntryFunction

public ActiveEntryFunction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkflowComponent

Throws:

ServiceException

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