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 and 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 int	GLOBAL_VALIDATE_ACTION_ID The action id of global validation
static String	INVALIDATED_CONTENTS_KEY Constant for storing the result map into the transient variables map.
static String	VALID_LABEL Label for the validated version of contents.
static int	VALIDATE_ACTION_ID The action id of global validation
static String	VALIDATE_RECURSIVELY_ARG Label for the validated version of contents.
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 and Description
ValidateODFContentFunction()

Method Summary

Modifier and Type	Method and Description
protected void	_doValidateWorkflowAction(WorkflowAwareContent content, Map transientVars, int actionId) Validate a content
protected Map<String,Object>	_getInputs(Content content, Map transientVars) Get inputs
protected Set<String>	_getInvalidatedContents(Map transientVars) Get the contents that were not validated during global validation
protected void	_notifyObservers(Map transientVars, Content content) Notify observers of content validation
protected void	_validateContent(ModifiableWorkflowAwareContent content) Validates the content.
protected void	_validateRecursively(WorkflowAwareContent content, Map transientVars) Validate the referenced contents recursively
protected void	_validateReferencedContents(Collection<String> contentIds, Map transientVars) Validate the list of contents
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_RECURSIVELY_ARG

public static final String VALIDATE_RECURSIVELY_ARG

Label for the validated version of contents.

See Also:

Constant Field Values

INVALIDATED_CONTENTS_KEY

public static final String INVALIDATED_CONTENTS_KEY

Constant for storing the result map into the transient variables map.

GLOBAL_VALIDATE_ACTION_ID

public static final int GLOBAL_VALIDATE_ACTION_ID

The action id of global validation

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.

_validateRecursively

protected void _validateRecursively(WorkflowAwareContent content,
                                    Map transientVars)
                             throws com.opensymphony.workflow.WorkflowException

Validate the referenced contents recursively

Parameters:

content - The validated content

transientVars - The parameters from the call.

Throws:

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

_validateReferencedContents

protected void _validateReferencedContents(Collection<String> contentIds,
                                           Map transientVars)
                                    throws com.opensymphony.workflow.WorkflowException

Validate the list of contents

Parameters:

contentIds - The id of contents to validate

transientVars - The parameters from the call.

Throws:

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

_doValidateWorkflowAction

protected void _doValidateWorkflowAction(WorkflowAwareContent content,
                                         Map transientVars,
                                         int actionId)
                                  throws com.opensymphony.workflow.WorkflowException

Validate a content

Parameters:

content - The content to validate

transientVars - The parameters from the call.

actionId - The id of validate action

Throws:

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

_getInvalidatedContents

protected Set<String> _getInvalidatedContents(Map transientVars)
                                       throws com.opensymphony.workflow.WorkflowException

Get the contents that were not validated during global validation

Parameters:

transientVars - The parameters from the call.

Returns:

The unvalidated contents

Throws:

com.opensymphony.workflow.WorkflowException - if failed to get invalidated contents

_getInputs

protected Map<String,Object> _getInputs(Content content,
                                        Map transientVars)

Get inputs

Parameters:

content - The content to validate

transientVars - the parameters from the call.

Returns:

The inputs