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
OSWorkflow function for validating a ODF content.
If argument "recursively" is used, the referenced contents will be validated too.
-
Field Summary
Modifier and TypeFieldDescriptionprotected ContentWorkflowHelper
The workflow helper for contentsprotected ODFHelper
The ODF helperprotected ODFWorkflowHelper
The ODF workflow helperprotected AmetysObjectResolver
The Ametys object resolverstatic final String
Label for the validated version of contents.static final int
The action id of global validationstatic final int
The validate step idFields 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
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
_notifyObservers
(Map transientVars, Content content) Notify observers of content validationprotected void
Validates the content.void
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
-
Field Details
-
VALID_LABEL
Label for the validated version of contents.- See Also:
-
VALIDATE_ACTION_ID
The action id of global validation- See Also:
-
VALIDATED_STEP_ID
The validate step id- See Also:
-
_resolver
The Ametys object resolver -
_contentWorkflowHelper
The workflow helper for contents -
_odfHelper
The ODF helper -
_odfWorkflowHelper
The ODF workflow helper
-
-
Constructor Details
-
ValidateODFContentFunction
public ValidateODFContentFunction()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classAbstractContentWorkflowComponent
- 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 variablescontent
- The created content- Throws:
AmetysRepositoryException
- If an error occurred with the repositorycom.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.
-