Package org.ametys.cms.workflow

Class CreateVersionFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.AbstractContentFunction

org.ametys.cms.workflow.CreateVersionFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

CreateSynchronizedVersionFunction

public class CreateVersionFunction
extends AbstractContentFunction

Workflow function creating a new content version.

Nested Class Summary

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

EnhancedFunction.FunctionArgument

Field Summary

Fields inherited from class org.ametys.cms.workflow.AbstractContentFunction

_observationManager, _workflowProvider

Fields inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

_contentHelper, CONTENT_KEY, HAS_CHANGED_KEY

Fields inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

_logger, _manager, CONTEXT_PARAMETERS_KEY, FAIL_CONDITIONS_KEY, RESULT_MAP_KEY, WORKFLOW_ERRORS_KEY, WORKFLOW_WARNS_KEY

Constructor Summary

Constructors

Constructor	Description
CreateVersionFunction()

Method Summary

Modifier and Type	Method	Description
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
List<EnhancedFunction.FunctionArgument>	getArguments()	Get the list of accepted arguments for this function
I18nizableText	getDescription(Map<String,String> args)	Get the function descriptions depending on arguments values

Methods inherited from class org.ametys.cms.workflow.AbstractContentFunction

_addLabel, _addLockToken, _createVersion, _setCurrentStepId, _setCurrentStepIdAndNotify, initialize

Methods inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

getContent, service

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

Constructor Details

CreateVersionFunction

public CreateVersionFunction()

Method Details

execute

public void execute(Map transientVars,
 Map args,
 com.opensymphony.module.propertyset.PropertySet ps)
             throws com.opensymphony.workflow.WorkflowException

Throws:

com.opensymphony.workflow.WorkflowException

getArguments

public List<EnhancedFunction.FunctionArgument> getArguments()

Description copied from interface: EnhancedFunction

Get the list of accepted arguments for this function

Returns:

a List of argument names and associated description

getDescription

public I18nizableText getDescription(Map<String,String> args)

Description copied from interface: EnhancedFunction

Get the function descriptions depending on arguments values

Parameters:

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

Returns:

a description to display in workflow editor vue