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.List;
019import java.util.Map;
020
021import org.apache.commons.collections.ListUtils;
022
023import org.ametys.plugins.workflow.EnhancedFunction;
024import org.ametys.plugins.workflow.store.AmetysStep;
025import org.ametys.runtime.i18n.I18nizableText;
026
027import com.opensymphony.module.propertyset.PropertySet;
028import com.opensymphony.workflow.WorkflowException;
029import com.opensymphony.workflow.spi.Step;
030
031/**
032 * OSWorkflow function for setting the "validate" flag on steps, indicating they represent a validation step.<br>
033 * This function MUST be used as a post-function of the validation function.
034 */
035public class ValidationStepFunction implements EnhancedFunction
036{
037    @Override
038    public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException
039    {
040        Step createdStep = (Step) transientVars.get("createdStep");
041        
042        if (createdStep != null && createdStep instanceof AmetysStep)
043        {
044            ((AmetysStep) createdStep).setProperty("validation", true);
045            ((AmetysStep) createdStep).save();
046        }
047    }
048    
049    @Override
050    public List<FunctionArgument> getArguments()
051    {
052        return ListUtils.EMPTY_LIST;
053    }
054
055    @Override
056    public I18nizableText getDescription(Map<String, String> args)
057    {
058        return new I18nizableText("plugin.cms", "PLUGINS_CMS_VALIDATION_STEP_FUNCTION_DESCRIPTION");
059    }
060}