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.List;
019import java.util.Map;
020
021import javax.jcr.RepositoryException;
022
023import org.apache.commons.collections.ListUtils;
024
025import org.ametys.cms.repository.WorkflowAwareContent;
026import org.ametys.runtime.i18n.I18nizableText;
027
028import com.opensymphony.module.propertyset.PropertySet;
029import com.opensymphony.workflow.WorkflowException;
030
031/**
032 * OS workflow function to set the current step id
033 */
034public class SetCurrentStepIdAndNotifyFunction extends AbstractContentFunction
035{
036    
037    @Override
038    public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException
039    {
040        WorkflowAwareContent content = getContent(transientVars);
041        
042        try
043        {
044            // Add the lock token to the current session if the content is locked.
045            _addLockToken(content);
046            // Set the current step ID property.
047            _setCurrentStepIdAndNotify(content, transientVars);
048        }
049        catch (RepositoryException e)
050        {
051            throw new WorkflowException("Unable to add a lock token to the current session.", e);
052        }
053    }
054    
055    @Override
056    public List<FunctionArgument> getArguments()
057    {
058        return ListUtils.EMPTY_LIST;
059    }
060
061    @Override
062    public I18nizableText getDescription(Map<String, String> args)
063    {
064        return new I18nizableText("plugin.cms", "PLUGINS_CMS_SET_CURRENT_STEP_ID_AND_NOTIFY_FUNCTION_DESCRIPTION");
065    }
066}