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.Map;
019
020import org.ametys.cms.repository.Content;
021import org.ametys.cms.repository.WorkflowAwareContent;
022import org.ametys.plugins.workflow.AbstractWorkflowComponent;
023
024import com.opensymphony.workflow.WorkflowException;
025
026/**
027 * Abstract class for easily retrieving environment components
028 * in a condition or a function and especially a content.
029 */
030public abstract class AbstractContentWorkflowComponent extends AbstractWorkflowComponent
031{
032    /** Constant for storing the content into the transient variables map. */
033    public static final String CONTENT_KEY = Content.class.getName();
034
035    /**
036     * Retrieve the content associated with the workflow.
037     * @param transientVars the parameters from the call.
038     * @return the content.
039     * @throws WorkflowException if the content is not found.
040     */
041    protected WorkflowAwareContent getContent(Map transientVars) throws WorkflowException
042    {
043        WorkflowAwareContent content = (WorkflowAwareContent) transientVars.get(CONTENT_KEY);
044        
045        if (content == null)
046        {
047            throw new WorkflowException("Unable to retrieve content");
048        }
049        
050        // Found in transient variables map
051        return content;
052    }
053}