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 class org.ametys.plugins.workflow.AbstractWorkflowComponent

AbstractWorkflowComponent.ConditionFailure

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

EnhancedFunction.FunctionType

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_VALIDATION_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)
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
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

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

getArguments, getFullLabel

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

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