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, Initializable, LogEnabled, Serviceable

Direct Known Subclasses:

ValidateSynchronizedContentFunction

public class ValidateContentFunction
extends AbstractContentFunction

OSWorkflow function for validating a content.

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

Method Summary

Modifier and Type	Method	Description
protected void	_notifyObservers(Map transientVars, Content content)	Notify observers of content validation
protected void	_validateContent(ModifiableWorkflowAwareContent content)	Validates the content: set the validation metadata.
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)

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 Detail

ValidateContentFunction

public ValidateContentFunction()

Method Detail

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)
                         throws com.opensymphony.workflow.WorkflowException,
                                RepositoryException

Validates the content: set the validation metadata.

Parameters:

content - the content.

Throws:

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

RepositoryException - if an error occurs.