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