1 files changed, 67 insertions, 0 deletions
diff --git a/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/IGUIFormBuilder.java b/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/IGUIFormBuilder.java
new file mode 100644
index 000000000..198220e97
--- /dev/null
+++ b/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/IGUIFormBuilder.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2014 Federal Chancellery Austria
+ * MOA-ID has been developed in a cooperation between BRZ, the Federal
+ * Chancellery Austria - ICT staff unit, and Graz University of Technology.
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://www.osor.eu/eupl/
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ *
+ * This product combines work with different licenses. See the "NOTICE" text
+ * file for details on the various modules and licenses.
+ * The "NOTICE" text file is part of the distribution. Any derivative works
+ * that you distribute must include a readable copy of the "NOTICE" text file.
+ */
+package at.gv.egovernment.moa.id.auth.frontend.builder;
+
+import javax.servlet.http.HttpServletResponse;
+
+import at.gv.egovernment.moa.id.auth.frontend.exception.GUIBuildException;
+
+/**
+ * @author tlenz
+ *
+ */
+public interface IGUIFormBuilder {
+
+	/**
+	 * Parse a GUI template, with parameters into a http servlet-response 
+	 * and use the default http-response content-type.
+	 * <br><br>
+	 *  The parser use the <code>VelocityEngine</code> as internal template evaluator. 
+	 * 
+	 * @param httpResp http-response object
+	 * @param viewName Name of the template (with suffix), which should be used. 
+	 *    The template is selected by using the <code>getTemplate(String viewName)</code> method
+	 * @param viewParams Map of parameters, which should be added to template
+	 * @param loggerName String, which should be used from logger
+	 * 
+	 * @throws GUIBuildException
+	 */
+	public void build(HttpServletResponse httpResp, IGUIBuilderConfiguration config, String loggerName) throws GUIBuildException;
+
+	/**
+	 * Parse a GUI template, with parameters into a http servlet-response.
+	 * <br><br>
+	 *  The parser use the <code>VelocityEngine</code> as internal template evaluator. 
+	 * 
+	 * @param httpResp http-response object
+	 * @param viewName Name of the template (with suffix), which should be used. 
+	 *    The template is selected by using the <code>getTemplate(String viewName)</code> method
+	 * @param viewParams Map of parameters, which should be added to template
+	 * @param contentType http-response content-type, which should be set
+	 * @param loggerName String, which should be used from logger
+	 * 
+	 * @throws GUIBuildException
+	 */
+	void build(HttpServletResponse httpResp, IGUIBuilderConfiguration config, String contentType,
+			String loggerName) throws GUIBuildException;
+}