001/*
002 *  Copyright 2012 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.cms.workflow;
017
018import java.util.Map;
019
020import org.ametys.plugins.workflow.store.AmetysStep;
021
022import com.opensymphony.module.propertyset.PropertySet;
023import com.opensymphony.workflow.FunctionProvider;
024import com.opensymphony.workflow.WorkflowException;
025import com.opensymphony.workflow.spi.Step;
026
027/**
028 * OSWorkflow function for setting the "validate" flag on steps, indicating they represent a validation step.<br>
029 * This function MUST be used as a post-function of the validation function.
030 */
031public class ValidationStepFunction implements FunctionProvider
032{
033    @Override
034    public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException
035    {
036        Step createdStep = (Step) transientVars.get("createdStep");
037        
038        if (createdStep != null && createdStep instanceof AmetysStep)
039        {
040            ((AmetysStep) createdStep).setProperty("validation", true);
041            ((AmetysStep) createdStep).save();
042        }
043    }
044}