Package org.ametys.cms.workflow.extensions

Class ExtensibleFunction

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.workflow.extensions.ExtensibleFunction

All Implemented Interfaces:

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

public class ExtensibleFunction
extends AbstractLogEnabled
implements EnhancedFunction, Serviceable

Workflow function that will call each function registered on the extension point given as an argument

Nested Class Summary

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

EnhancedFunction.FunctionType

Field Summary

Fields

Modifier and Type	Field	Description
protected EnhancedFunctionExtensionPoint	_enhancedFunctionEP	The enhanced function extension point
protected ServiceManager	_manager	The service manager
protected static final String	EXTENSION_POINT_ROLE_ARGS_KEY	The rights key.

Constructor Summary

Constructors

Constructor	Description
ExtensibleFunction()

Method Summary

Modifier and Type	Method	Description
protected com.opensymphony.workflow.FunctionProvider	_getFunctionProvider(String functionId, String functionProviderRole)	Get the function provider denoted
protected ExtensionPoint<String>	_getFunctionsExtensionPoint(Map args)	Get the function extension point given in args
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
List<WorkflowArgument>	getArguments()	Get the list of accepted arguments for this function
I18nizableText	getFullLabel(Map<String,String> args)	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
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

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

getVisibilities

Field Details

EXTENSION_POINT_ROLE_ARGS_KEY

protected static final String EXTENSION_POINT_ROLE_ARGS_KEY

The rights key.

See Also:

• Constant Field Values

_manager

protected ServiceManager _manager

The service manager

_enhancedFunctionEP

protected EnhancedFunctionExtensionPoint _enhancedFunctionEP

The enhanced function extension point

Constructor Details

ExtensibleFunction

public ExtensibleFunction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

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

_getFunctionProvider

protected com.opensymphony.workflow.FunctionProvider _getFunctionProvider(String functionId,
 String functionProviderRole)
                                                                   throws com.opensymphony.workflow.WorkflowException

Get the function provider denoted

Parameters:

functionId - The id of the extension that gave the role

functionProviderRole - The role of the component to find

Returns:

The workflow function

Throws:

com.opensymphony.workflow.WorkflowException - If the role cannot be found

_getFunctionsExtensionPoint

protected ExtensionPoint<String> _getFunctionsExtensionPoint(Map args)
                                                      throws com.opensymphony.workflow.WorkflowException

Get the function extension point given in args

Parameters:

args - The workflow arguments

Returns:

The extension point

Throws:

com.opensymphony.workflow.WorkflowException - If the extension point is not configured or does not exist

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

getArguments

public List<WorkflowArgument> 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

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

Description copied from interface: EnhancedFunction

Get the function label depending on arguments values

Specified by:

getFullLabel in interface EnhancedFunction

Parameters:

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

Returns:

a label to display in workflow editor vue