mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
60c08702d5
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18963 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
112 lines
3.6 KiB
Java
112 lines
3.6 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>. */
|
|
package org.alfresco.web.forms;
|
|
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
import java.io.OutputStream;
|
|
import java.io.Serializable;
|
|
import java.util.Map;
|
|
import org.w3c.dom.Document;
|
|
import org.xml.sax.SAXException;
|
|
|
|
/**
|
|
* Describes a template that is used for rendering form instance data.
|
|
*
|
|
* @author Ariel Backenroth
|
|
*/
|
|
public interface RenderingEngineTemplate
|
|
extends Serializable
|
|
{
|
|
/** the name of the rendering engine template */
|
|
public String getName();
|
|
|
|
/** the title of the rendering engine template */
|
|
public String getTitle();
|
|
|
|
/** the description of the rendering engine template */
|
|
public String getDescription();
|
|
|
|
/** the output path pattern for renditions */
|
|
public String getOutputPathPattern();
|
|
|
|
/**
|
|
* Provides the rendering engine to use to process this template.
|
|
*
|
|
* @return the rendering engine to use to process this template.
|
|
*/
|
|
public RenderingEngine getRenderingEngine();
|
|
|
|
/**
|
|
* Provides an input stream to the rendering engine template.
|
|
*
|
|
* @return the input stream to the rendering engine template.
|
|
*/
|
|
public InputStream getInputStream()
|
|
throws IOException;
|
|
|
|
/**
|
|
* Returns the output path for the rendition.
|
|
*
|
|
* @param formInstanceData the form instance data to use for
|
|
* processing the pattern.
|
|
* @param currentAVMPath the current path where the form is being created.
|
|
* @param name the name which is used in a pattern
|
|
* @return the output path for the rendition.
|
|
*/
|
|
public String getOutputPathForRendition(final FormInstanceData formInstanceData,
|
|
final String currentAVMPath, final String name);
|
|
|
|
/**
|
|
* Returns the mimetype to use when generating content for this
|
|
* output method.
|
|
*
|
|
* @return the mimetype to use when generating content for this
|
|
* output method, such as text/html, text/xml, application/pdf.
|
|
*/
|
|
public String getMimetypeForRendition();
|
|
|
|
/**
|
|
* Produces a rendition of the provided formInstanceData.
|
|
*
|
|
* @param formInstanceData the form instance data for which to produce
|
|
* the rendition.
|
|
* @param renditionAVMPath the path to use for the rendition.
|
|
*/
|
|
public Rendition render(final FormInstanceData formInstanceData,
|
|
final String renditionAVMPath)
|
|
throws IOException,
|
|
SAXException,
|
|
RenderingEngine.RenderingException;
|
|
|
|
/**
|
|
* Produces a rendition of the provided formInstanceData to an existing
|
|
* rendition.
|
|
*
|
|
* @param formInstanceData the form instance data for which to produce
|
|
* the rendition.
|
|
* @param rendition the rendition to rerender
|
|
*/
|
|
public void render(final FormInstanceData formInstanceData,
|
|
final Rendition rendition)
|
|
throws IOException,
|
|
SAXException,
|
|
RenderingEngine.RenderingException;
|
|
}
|