Package org.ametys.plugins.forms.workflow

Class AbstractFormEntriesWorkflowStepsClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.cms.clientsideelement.WorkflowStepsClientSideElement

org.ametys.plugins.forms.workflow.AbstractFormEntriesWorkflowStepsClientSideElement

All Implemented Interfaces:

ClientSideElement, MenuClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

FormEntriesWorkflowStepsClientSideElement, FormEntryWorkflowStepsClientSideElement

public abstract class AbstractFormEntriesWorkflowStepsClientSideElement
extends WorkflowStepsClientSideElement

This class creates multiple toggle buttons each representing a workflow step on form entries

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields inherited from class org.ametys.cms.clientsideelement.WorkflowStepsClientSideElement

_contentHelper, _menuItemManager, _menuItems, _referencedClientSideElement, _resolver, _scripts, _smanager, _unresolvedMenuItems, _userManager, _workflowHelper, _workflowProvider

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
AbstractFormEntriesWorkflowStepsClientSideElement()

Method Summary

Modifier and Type	Method	Description
protected void	_additionalMenuItemConfiguration(Configuration itemConf, DefaultConfiguration classConf, int actionId, Map<String,Object> parameters)	Additional configuration for menu items
protected void	_configureDefaultDescriptions(Map<String,Object> parameters)	Configure the default description
protected ClientSideElement.Script	_configureScript(Configuration configuration)	Configure the script
protected void	_configureWorkflowStep(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, Integer stepId, Map<String,Object> stepParameters, Configuration stepConfiguration, List<Integer> allowedActionIds)	Configure the parameters specific to the workflow, for the given step
protected abstract List<ClientSideElement.ScriptFile>	_getAdditionalScriptFiles()	Get the additional script files to import
protected String	_getDefaultPluginName()	Get the default plugin name
abstract Map<String,Object>	getWorkflowState(List<Object> entryIds, String formId, String scriptId)	Get the workflow state of contents

Methods inherited from class org.ametys.cms.clientsideelement.WorkflowStepsClientSideElement

_configureMenuItems, _configureParameters, _configureScripts, _configureWorkflow, _configureWorkflowStepActions, _getAllowedActions, _getAllowedSteps, _getDefaultActionClassName, _getDefaultMenuClassName, _getSelectionTargetId, configure, getReferencedClientSideElements, getScripts, getWorkflowState, service

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, getDependencies, getId, getPluginName, getRights, getScripts, hasRight, setPluginInfo, toString

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, wait, wait, wait

Constructor Details

AbstractFormEntriesWorkflowStepsClientSideElement

public AbstractFormEntriesWorkflowStepsClientSideElement()

Method Details

_configureWorkflowStep

protected void _configureWorkflowStep(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor,
 Integer stepId,
 Map<String,Object> stepParameters,
 Configuration stepConfiguration,
 List<Integer> allowedActionIds)
                               throws ConfigurationException

Description copied from class: WorkflowStepsClientSideElement

Configure the parameters specific to the workflow, for the given step

Overrides:

_configureWorkflowStep in class WorkflowStepsClientSideElement

Parameters:

workflowDescriptor - The descriptor of the workflow

stepId - The step

stepParameters - The parameters of the step

stepConfiguration - The step configuration

allowedActionIds - The list of globally allowed actions

Throws:

ConfigurationException - If an error occurs

_configureScript

protected ClientSideElement.Script _configureScript(Configuration configuration)
                                             throws ConfigurationException

Description copied from class: StaticFileImportsClientSideElement

Configure the script

Overrides:

_configureScript in class WorkflowStepsClientSideElement

Parameters:

configuration - the global configuration

Returns:

The script created

Throws:

ConfigurationException - The configuration is incorrect

_getAdditionalScriptFiles

protected abstract List<ClientSideElement.ScriptFile> _getAdditionalScriptFiles()

Get the additional script files to import

Returns:

the list of script

_getDefaultPluginName

protected String _getDefaultPluginName()

Description copied from class: WorkflowStepsClientSideElement

Get the default plugin name

Overrides:

_getDefaultPluginName in class WorkflowStepsClientSideElement

Returns:

the default plugin name

_additionalMenuItemConfiguration

protected void _additionalMenuItemConfiguration(Configuration itemConf,
 DefaultConfiguration classConf,
 int actionId,
 Map<String,Object> parameters)

Description copied from class: WorkflowStepsClientSideElement

Additional configuration for menu items

Overrides:

_additionalMenuItemConfiguration in class WorkflowStepsClientSideElement

Parameters:

itemConf - The item configuration

classConf - The class configuration

actionId - The workflow action id

parameters - The script parameters

_configureDefaultDescriptions

protected void _configureDefaultDescriptions(Map<String,Object> parameters)

Description copied from class: WorkflowStepsClientSideElement

Configure the default description

Overrides:

_configureDefaultDescriptions in class WorkflowStepsClientSideElement

Parameters:

parameters - The parameters

getWorkflowState

public abstract Map<String,Object> getWorkflowState(List<Object> entryIds,
 String formId,
 String scriptId)

Get the workflow state of contents

Parameters:

entryIds - The ids of the selected entries

formId - The id of the form

scriptId - The id of the script

Returns:

The workflow state as a map