001/*
002 * (C) Copyright 2006-2007 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     dragos
016 *
017 * $Id$
018 */
019package org.nuxeo.ecm.platform.rendering;
020
021/**
022 * A RenderingEngine will be instantiated by the RenderingService according with the descriptor specified for it. The
023 * specific implementation of a RenderingEngine must be in classpath for it to be instantiated and used.
024 *
025 * @author <a href="mailto:dm@nuxeo.com">Dragos Mihalache</a>
026 */
027public interface RenderingEngine {
028
029    String getFormatName();
030
031    /**
032     * Processes the given context and return a rendering result.
033     * <p>
034     * The processing must never return null. If some error occurs it must throw an exception.
035     *
036     * @param ctx the context to process
037     */
038    RenderingResult process(RenderingContext ctx) throws RenderingException;
039}