001/*
002 *  Copyright 2010 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;
029
030/**
031 * Function setting the user comment into the step before it's stored.
032 */
033public class CommentStepFunction implements EnhancedFunction
034{
035    @Override
036    public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException
037    {
038        String comment = (String) transientVars.get("comment");
039        
040        if (comment != null && comment.length() > 0)
041        {
042            AmetysStep step = (AmetysStep) ((List) transientVars.get("currentSteps")).get(0);
043            
044            step.setProperty("comment", comment);
045        }
046    }
047    
048    @Override
049    public List<FunctionArgument> getArguments()
050    {
051        return ListUtils.EMPTY_LIST;
052    }
053
054    @Override
055    public I18nizableText getDescription(Map<String, String> args)
056    {
057        return new I18nizableText("plugin.cms", "PLUGINS_CMS_COMMENT_STEP_FUNCTION_DESCRIPTION");
058    }
059}