001/*
002 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
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 *
016 * Contributors:
017 *     dragos
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.platform.rendering;
023
024import java.io.Serializable;
025import java.util.Map;
026
027import org.nuxeo.runtime.model.Adaptable;
028
029/**
030 * Base class for rendering contexts.
031 * <p>
032 * The org.nuxeo.runtime.model.Adaptable interface may be used to add adapting capabilities to context objects. This may
033 * be used to retrieve adapters to other type of contexts (like the freemarker one).
034 *
035 * @author <a href="mailto:dm@nuxeo.com">Dragos Mihalache</a>
036 */
037public interface RenderingContext extends Map<String, Object>, Adaptable, Serializable {
038
039    /**
040     * Either or not this rendering context accepts the given engine.
041     * <p>
042     * If the engione is not acepted it will be ignored by the rendering service when processing this context
043     *
044     * @param engine the engine to test
045     * @return true if the engine is eligible to process this context, false otherwise
046     */
047    boolean accept(RenderingEngine engine);
048
049}