Package org.ametys.odf.workflow

Class ValidateODFContentFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.AbstractContentFunction

org.ametys.odf.workflow.ValidateODFContentFunction

All Implemented Interfaces:

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

public class ValidateODFContentFunction
extends AbstractContentFunction

OSWorkflow function for validating a ODF content. If argument "recursively" is used, the referenced contents will be validated too.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentWorkflowHelper	_contentWorkflowHelper	The workflow helper for contents
protected ODFHelper	_odfHelper	The ODF helper
protected ODFWorkflowHelper	_odfWorkflowHelper	The ODF workflow helper
protected AmetysObjectResolver	_resolver	The Ametys object resolver
static String	VALID_LABEL	Label for the validated version of contents.
static int	VALIDATE_ACTION_ID	The action id of global validation
static int	VALIDATED_STEP_ID	The validate step id

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

_observationManager, _workflowProvider

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

_contentHelper, CONTENT_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
ValidateODFContentFunction()

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.
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
void	service(ServiceManager smanager)

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

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 Detail

VALID_LABEL

public static final String VALID_LABEL

Label for the validated version of contents.

See Also:

Constant Field Values

VALIDATE_ACTION_ID

public static final int VALIDATE_ACTION_ID

The action id of global validation

See Also:

Constant Field Values

VALIDATED_STEP_ID

public static final int VALIDATED_STEP_ID

The validate step id

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The workflow helper for contents

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_odfWorkflowHelper

protected ODFWorkflowHelper _odfWorkflowHelper

The ODF workflow helper

Constructor Detail

ValidateODFContentFunction

public ValidateODFContentFunction()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentWorkflowComponent

Throws:

ServiceException

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.

Parameters:

content - the content.

Throws:

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

RepositoryException - if an error occurs.