001/*
002 *  Copyright 2011 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 javax.jcr.RepositoryException;
021
022import org.ametys.cms.repository.WorkflowAwareContent;
023import org.ametys.runtime.i18n.I18nizableText;
024
025import com.opensymphony.module.propertyset.PropertySet;
026import com.opensymphony.workflow.WorkflowException;
027
028/**
029 * OS workflow function to set the current step id
030 */
031public class SetCurrentStepIdAndNotifyFunction extends AbstractContentFunction
032{
033    
034    @Override
035    public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException
036    {
037        WorkflowAwareContent content = getContent(transientVars);
038        
039        try
040        {
041            // Add the lock token to the current session if the content is locked.
042            _addLockToken(content);
043            // Set the current step ID property.
044            _setCurrentStepIdAndNotify(content, transientVars);
045        }
046        catch (RepositoryException e)
047        {
048            throw new WorkflowException("Unable to add a lock token to the current session.", e);
049        }
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_SET_CURRENT_STEP_ID_AND_NOTIFY_FUNCTION_LABEL");
062    }
063}