Package org.ametys.plugins.contentio.synchronize.workflow

Class ValidateSynchronizedContentFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.AbstractContentFunction

org.ametys.cms.workflow.ValidateContentFunction

org.ametys.plugins.contentio.synchronize.workflow.ValidateSynchronizedContentFunction

All Implemented Interfaces:

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

public class ValidateSynchronizedContentFunction
extends ValidateContentFunction

OSWorkflow function for validating a synchronizable content.

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.ValidateContentFunction

IS_MAJOR

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

_observationManager, _workflowProvider, EVENT_TO_NOTIFY_KEY

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

Method Summary

Modifier and Type	Method	Description
protected String	_getDefaultEvent()	Get the default event to notify
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	_setCurrentStepIdAndNotify(WorkflowAwareContent content, Map transientVars)	Set the content's current step ID and notify the observers that the content's workflow has changed.
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
I18nizableText	getLabel()	Get the label for this function

Methods inherited from class org.ametys.cms.workflow.ValidateContentFunction

_notifyObservers, _validateContent, getFunctionExecType

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

_addLabel, _addLockToken, _createVersion, _notify, _setCurrentStepId, 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

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

getArguments, getFullLabel, getVisibilities

Constructor Details

ValidateSynchronizedContentFunction

public ValidateSynchronizedContentFunction()

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

Overrides:

execute in class ValidateContentFunction

Throws:

com.opensymphony.workflow.WorkflowException

_setCurrentStepIdAndNotify

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

Description copied from class: AbstractContentFunction

Set the content's current step ID and notify the observers that the content's workflow has changed.

Overrides:

_setCurrentStepIdAndNotify in class AbstractContentFunction

Parameters:

content - the content.

transientVars - The workflow transient vars.

Throws:

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

_getDefaultEvent

protected String _getDefaultEvent()

Description copied from class: AbstractContentFunction

Get the default event to notify

Overrides:

_getDefaultEvent in class AbstractContentFunction

Returns:

the default event

_isMajorValidation

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

Description copied from class: ValidateContentFunction

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

Overrides:

_isMajorValidation in class ValidateContentFunction

Parameters:

contextParameters - the context parameters

args - the arguments

Returns:

true if the current validation is a major validation.

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedFunction

Get the label for this function

Specified by:

getLabel in interface EnhancedFunction

Overrides:

getLabel in class ValidateContentFunction

Returns:

the label