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.cms.content.ContentSaxer;
021import org.ametys.cms.repository.WorkflowAwareContent;
022import org.ametys.plugins.repository.version.VersionableAmetysObject;
023import org.ametys.runtime.i18n.I18nizableText;
024
025import com.opensymphony.module.propertyset.PropertySet;
026import com.opensymphony.workflow.WorkflowException;
027
028/**
029 * Workflow function creating a new content version.
030 */
031public class CreateVersionFunction extends AbstractContentFunction
032{
033    /** The new version created */
034    public static final String RESULT_VERSION = "version";
035    
036    @Override
037    public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException
038    {
039        WorkflowAwareContent content = getContent(transientVars);
040        
041        boolean createVersion = !"true".equals(transientVars.get("prevent-version-creation"));
042        
043        if (createVersion)
044        {
045            _createVersion(content);
046        }
047        
048        Map<String, Object> resultsMap = getResultsMap(transientVars);
049        resultsMap.put(RESULT_VERSION, ContentSaxer.getEditionRevision((VersionableAmetysObject) content));
050    }
051    
052    @Override
053    public FunctionType getFunctionExecType()
054    {
055        return FunctionType.POST;
056    }
057    
058    @Override
059    public I18nizableText getLabel()
060    {
061        return new I18nizableText("plugin.cms", "PLUGINS_CMS_CREATE_VERSION_FUNCTION_LABEL");
062    }
063}