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