001/*
002 * (C) Copyright 2006-20012 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 *     Nuxeo - initial API and implementation
016 *
017 */
018
019package org.nuxeo.template.api;
020
021import java.io.IOException;
022import java.util.List;
023
024import org.nuxeo.ecm.core.api.Blob;
025import org.nuxeo.template.api.adapters.TemplateBasedDocument;
026
027/**
028 * Interface used to drive rendition of the {@link TemplateBasedDocument}
029 *
030 * @author Tiry (tdelprat@nuxeo.com)
031 */
032public interface TemplateProcessor {
033
034    /**
035     * Perform rendering of the named template against the {@link TemplateBasedDocument}
036     *
037     * @param templateDocument
038     * @param templateName
039     * @return
040     */
041    public Blob renderTemplate(TemplateBasedDocument templateDocument, String templateName) throws IOException;
042
043    /**
044     * Extract parameters from the Template file.
045     *
046     * @param blob
047     * @return List of parameters for this template
048     */
049    public List<TemplateInput> getInitialParametersDefinition(Blob blob) throws IOException;
050}