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, LogEnabled, Serviceable

public class ExtensibleFunction
extends AbstractLogEnabled
implements com.opensymphony.workflow.FunctionProvider, Serviceable

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ServiceManager	_manager The service manager
protected static String	EXTENSION_POINT_ROLE_ARGS_KEY The rights key.

Constructor Summary

Constructors

Constructor and Description
ExtensibleFunction()

Method Summary

Modifier and Type	Method and 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)
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

Field Detail

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

Constructor Detail

ExtensibleFunction

public ExtensibleFunction()

Method Detail

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