Package org.ametys.cms.workflow

Class MarkContentArchivedFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.MarkContentArchivedFunction

All Implemented Interfaces:

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

public class MarkContentArchivedFunction
extends AbstractContentWorkflowComponent
implements EnhancedFunction

Workflow function which marks a content archived.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

AbstractWorkflowComponent.ConditionFailure

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

EnhancedFunction.FunctionType

Field Summary

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_VALIDATION_KEY

Constructor Summary

Constructors

Constructor	Description
MarkContentArchivedFunction()

Method Summary

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

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

Methods inherited from interface org.ametys.plugins.workflow.EnhancedFunction

getVisibilities

Constructor Details

MarkContentArchivedFunction

public MarkContentArchivedFunction()

Method Details

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

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

Description copied from interface: EnhancedFunction

Get the function label depending on arguments values

Specified by:

getFullLabel in interface EnhancedFunction

Parameters:

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

Returns:

a label to display in workflow editor vue