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.store.AmetysStep;
022
023import com.opensymphony.module.propertyset.PropertySet;
024import com.opensymphony.workflow.FunctionProvider;
025import com.opensymphony.workflow.WorkflowException;
026
027/**
028 * Function setting the user comment into the step before it's stored.
029 */
030public class CommentStepFunction implements FunctionProvider
031{
032    @Override
033    public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException
034    {
035        String comment = (String) transientVars.get("comment");
036        
037        if (comment != null && comment.length() > 0)
038        {
039            AmetysStep step = (AmetysStep) ((List) transientVars.get("currentSteps")).get(0);
040            
041            step.setProperty("comment", comment);
042        }
043    }
044}