Files
alfresco-community-repo/source/java/org/alfresco/web/forms/RenderingEngine.java
Ariel Backenroth a25d85ee83 - moving generic xml parsing utilities out of FormsService and into their own class
- refactoring to generate and regenerate methods to make it easier to use project level overridden properties, and to at some point (soon) make it possible to make error handling for rendering engines more robust
- added a web project object to encapsulate web project properties and provide a central location for getting forms and rendering engines with web project level overridden properties
- made select default workflow screen match wireframes
- using the same workflowdefault type in the wcm model for web projects and forms.
- using outputpathpattern aspect consistently
- using commons.io to parse paths
- using form name rather than noderef as parameter for selected form from content forms dashlet
- fixed bug where rendition properties noderef wasn't being properly associated with renditions causing problems with regenerate
- using multivalued properties to track renditions
- remove weird registerRendition/registerFormInstanceData calls.  no longer necessary since generateRendition and regenerate are done within forminstancedata and rendition
- adding default workflow parameters as property of Form
- adding a unique name property to rendering engine templates to allow for looking one up by name


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4702 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2006-12-31 08:45:42 +00:00

89 lines
2.4 KiB
Java

/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.web.forms;
import org.alfresco.service.cmr.repository.NodeRef;
import java.io.IOException;
import java.io.OutputStream;
import java.io.Serializable;
import java.util.Map;
import org.w3c.dom.Document;
import org.xml.sax.SAXException;
/**
* Serializes the xml instance data collected by a form to a writer.
*
* @author Ariel Backenroth
*/
public interface RenderingEngine
extends Serializable
{
/////////////////////////////////////////////////////////////////////////////
public static class RenderingException
extends Exception
{
public RenderingException(final String msg)
{
super(msg);
}
public RenderingException(final Exception cause)
{
super(cause);
}
public RenderingException(final String msg, final Exception cause)
{
super(msg, cause);
}
}
/////////////////////////////////////////////////////////////////////////////
/**
* Returns the rendering engines name.
*
* @return the name of the rendering engine.
*/
public String getName();
/**
* Returns the default file extension for rendering engine templates for this
* rendering engine.
*
* @return the default file extension for rendering engine templates for this
* rendering engine.
*/
public String getDefaultTemplateFileExtension();
/**
* Renders the xml data in to a presentation format.
*
* @param formInstanceData the xml content to serialize.
* @param ret the rendering engine template
* @param form the form that collected the xml content.
* @param rendition the rendition to serialize to.
*/
public void render(final FormInstanceData formInstanceData,
final RenderingEngineTemplate ret,
final Rendition rendition)
throws IOException, RenderingException, SAXException;
}