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.ametys.plugins.workflow.EnhancedFunction;
022import org.ametys.plugins.workflow.store.AmetysStep;
023import org.ametys.plugins.workflow.support.WorkflowHelper.WorkflowVisibility;
024import org.ametys.runtime.i18n.I18nizableText;
025
026import com.opensymphony.module.propertyset.PropertySet;
027import com.opensymphony.workflow.WorkflowException;
028
029/**
030 * Function setting the user comment into the step before it's stored.
031 */
032public class CommentStepFunction implements EnhancedFunction
033{
034    @Override
035    public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException
036    {
037        String comment = (String) transientVars.get("comment");
038        
039        if (comment != null && comment.length() > 0)
040        {
041            AmetysStep step = (AmetysStep) ((List) transientVars.get("currentSteps")).get(0);
042            
043            step.setProperty("comment", comment);
044        }
045    }
046    
047    @Override
048    public FunctionType getFunctionExecType()
049    {
050        return FunctionType.POST;
051    }
052
053    @Override
054    public I18nizableText getLabel()
055    {
056        return new I18nizableText("plugin.cms", "PLUGINS_CMS_COMMENT_STEP_FUNCTION_LABEL");
057    }
058    
059    @Override
060    public List<WorkflowVisibility> getVisibilities()
061    {
062        List<WorkflowVisibility> visibilities = EnhancedFunction.super.getVisibilities();
063        visibilities.add(WorkflowVisibility.USER);
064        return visibilities;
065    }
066}