Package org.ametys.plugins.forms.helper

Class FormWorkflowHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.helper.FormWorkflowHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class FormWorkflowHelper
extends AbstractLogEnabled
implements Serviceable, Component

Helper for manipulating workflows for Form

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkflowHelper	_workflowHelper	The workflow helper component
protected WorkflowProvider	_workflowProvider	The workflow provider
static final String	EDIT_ACTION	The edit action type
static final String	EDIT_BY_SUBMITTER_ACTION	The edit by submitter action type
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
FormWorkflowHelper()

Method Summary

Modifier and Type	Method	Description
protected List<com.opensymphony.workflow.loader.ActionDescriptor>	getAvailableActions(FormEntry entry, Predicate<String> actionTypeFilter)	Get the wanted available actions for the given form entry
List<com.opensymphony.workflow.loader.ActionDescriptor>	getAvailableActionsExcludingTypes(FormEntry entry, List<String> excludedTypes)	Get the non excluded available actions for the given form entry
List<com.opensymphony.workflow.loader.ActionDescriptor>	getAvailableActionsRestrictedToTypes(FormEntry entry, List<String> types)	Get the available actions for the given form entry and wanted action types
void	initializeWorkflow(FormEntry entry)	Initialize workflow for form entry
void	service(ServiceManager serviceManager)

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 Details

ROLE

public static final String ROLE

Avalon Role

EDIT_ACTION

public static final String EDIT_ACTION

The edit action type

See Also:

• Constant Field Values

EDIT_BY_SUBMITTER_ACTION

public static final String EDIT_BY_SUBMITTER_ACTION

The edit by submitter action type

See Also:

• Constant Field Values

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper component

Constructor Details

FormWorkflowHelper

public FormWorkflowHelper()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initializeWorkflow

public void initializeWorkflow(FormEntry entry)
                        throws Exception

Initialize workflow for form entry

Parameters:

entry - the form entry

Throws:

Exception - if an error occurred

getAvailableActionsRestrictedToTypes

public List<com.opensymphony.workflow.loader.ActionDescriptor> getAvailableActionsRestrictedToTypes(FormEntry entry,
 List<String> types)

Get the available actions for the given form entry and wanted action types

Parameters:

entry - The form entry

types - The action types to include. If empty, all available actions are returned. Otherwise, only actions with the specified types are returned.

Returns:

The list of wanted available actions

getAvailableActionsExcludingTypes

public List<com.opensymphony.workflow.loader.ActionDescriptor> getAvailableActionsExcludingTypes(FormEntry entry,
 List<String> excludedTypes)

Get the non excluded available actions for the given form entry

Parameters:

entry - The form entry

excludedTypes - The action types to exclude. If empty, all available actions are returned. Otherwise, only actions whose type is not listed are returned.

Returns:

The list of available actions except the excluded ones

getAvailableActions

protected List<com.opensymphony.workflow.loader.ActionDescriptor> getAvailableActions(FormEntry entry,
 Predicate<String> actionTypeFilter)

Get the wanted available actions for the given form entry

Parameters:

entry - The form entry

actionTypeFilter - The filter to apply on the action type or null to retrieve all actions

Returns:

The list of accepted available actions