Package org.ametys.cms.workflow

Class ValidateContentFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.AbstractContentFunction

org.ametys.cms.workflow.ValidateContentFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

ValidateSynchronizedContentFunction

public class ValidateContentFunction
extends AbstractContentFunction

OSWorkflow function for validating a content.

Nested Class Summary

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

EnhancedFunction.FunctionArgument

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IS_MAJOR	Context parameter for major validation

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
ValidateContentFunction()

Method Summary

Modifier and Type	Method	Description
protected boolean	_isMajorValidation(Map<String,Object> contextParameters, Map args)	Search into context parameters and arguments if major information is filled, if not default value is true.
protected void	_notifyObservers(Map transientVars, Content content)	Notify observers of content validation
protected void	_validateContent(ModifiableWorkflowAwareContent content, Map transientVars, Map args)	Validates the content: set the validation metadata.
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

Field Details

IS_MAJOR

public static final String IS_MAJOR

Context parameter for major validation

See Also:

• Constant Field Values

Constructor Details

ValidateContentFunction

public ValidateContentFunction()

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

_notifyObservers

protected void _notifyObservers(Map transientVars,
 Content content)
                         throws AmetysRepositoryException,
com.opensymphony.workflow.WorkflowException

Notify observers of content validation

Parameters:

transientVars - The transient variables

content - The created content

Throws:

AmetysRepositoryException - If an error occurred with the repository

com.opensymphony.workflow.WorkflowException - If an error occurred with the workflow

_validateContent

protected void _validateContent(ModifiableWorkflowAwareContent content,
 Map transientVars,
 Map args)
                         throws com.opensymphony.workflow.WorkflowException,
javax.jcr.RepositoryException

Validates the content: set the validation metadata.

Parameters:

content - the content.

transientVars - the transient vars

args - the arguments

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs.

javax.jcr.RepositoryException - if an error occurs.

_isMajorValidation

protected boolean _isMajorValidation(Map<String,Object> contextParameters,
 Map args)

Search into context parameters and arguments if major information is filled, if not default value is true.

Parameters:

contextParameters - the context parameters

args - the arguments

Returns:

true if the current validation is a major validation.

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