- renaming everything in order to get consistent good terminology for forms.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@4182 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/web/forms/RenderingEngine.java

@@ -0,0 +1,77 @@
+/*
+ * 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.Serializable;
+import java.io.Writer;
+import java.util.Map;
+import org.w3c.dom.Document;
+
+/**
+ * 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 Exception cause)
+      {
+         super(cause);
+      }
+
+      public RenderingException(final String msg, final Exception cause)
+      {
+         super(msg, cause);
+      }
+   }
+
+   /////////////////////////////////////////////////////////////////////////////
+
+   /** the noderef associated with this output method */
+   public NodeRef getNodeRef();
+
+   /**
+    * Serializes the xml data in to a presentation format.
+    *
+    * @param xmlContent the xml content to serialize
+    * @param form the form that collected the xml content.
+    * @param sandBoxUrl the url of the current sandbox
+    * @param out the writer to serialize to.
+    */
+   public void generate(final Document xmlContent,
+                        final Map<String, String> parameters,
+                        final Writer out)
+      throws IOException, RenderingException;
+
+   /**
+    * Returns the file extension to use when generating content for this
+    * output method.
+    *
+    * @return the file extension to use when generating content for this
+    * output method, such as html, rss, pdf.
+    */
+   public String getFileExtension();
+}