summaryrefslogtreecommitdiff
path: root/eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiFormBuilder.java
diff options
context:
space:
mode:
Diffstat (limited to 'eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiFormBuilder.java')
-rw-r--r--eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiFormBuilder.java40
1 files changed, 21 insertions, 19 deletions
diff --git a/eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiFormBuilder.java b/eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiFormBuilder.java
index 5a7ce49d..ff90e9cc 100644
--- a/eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiFormBuilder.java
+++ b/eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiFormBuilder.java
@@ -1,16 +1,19 @@
package at.gv.egiz.eaaf.core.api.gui;
import java.io.InputStream;
+
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
-import at.gv.egiz.eaaf.core.exceptions.GuiBuildException;
+
import org.apache.velocity.VelocityContext;
-public interface IVelocityGuiFormBuilder extends IGuiFormBuilder {
+import at.gv.egiz.eaaf.core.exceptions.GuiBuildException;
+public interface IVelocityGuiFormBuilder extends IGuiFormBuilder {
/**
- * Generate a new {@link VelocityContext} and populate it with MOA-ID GUI parameters.
+ * Generate a new {@link VelocityContext} and populate it with MOA-ID GUI
+ * parameters.
*
* @param config GUI builder configuration
* @return
@@ -18,28 +21,27 @@ public interface IVelocityGuiFormBuilder extends IGuiFormBuilder {
VelocityContext generateVelocityContextFromConfiguration(
IVelocityGuiBuilderConfiguration config);
-
/**
* Load the template from different resources.
*
* @param config GUI builder configuration
- * @return An {@link InputStream} but never null. The {@link InputStream} had to be closed be the
- * invoking method
+ * @return An {@link InputStream} but never null. The {@link InputStream} had to
+ * be closed be the invoking method
* @throws GuiBuildException In case of an error
*/
InputStream getTemplateInputStream(IVelocityGuiBuilderConfiguration config)
throws GuiBuildException;
-
/**
- * Parse a GUI template, with parameters into a http servlet-response and use the default
- * http-response content-type. <br>
+ * 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.
+ * The parser use the <code>VelocityEngine</code> as internal template
+ * evaluator.
*
- * @param httpReq http-request object
- * @param httpResp http-response object
- * @param config Configuration object
+ * @param httpReq http-request object
+ * @param httpResp http-response object
+ * @param config Configuration object
* @param loggerName String, which should be used from logger
*
* @throws GuiBuildException in case of an error
@@ -47,17 +49,17 @@ public interface IVelocityGuiFormBuilder extends IGuiFormBuilder {
void build(HttpServletRequest httpReq, HttpServletResponse httpResp,
IVelocityGuiBuilderConfiguration 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.
+ * The parser use the <code>VelocityEngine</code> as internal template
+ * evaluator.
*
- * @param httpReq http-request object
- * @param httpResp http-response object
- * @param config Configuration object
+ * @param httpReq http-request object
+ * @param httpResp http-response object
+ * @param config Configuration object
* @param contentType http-response content-type, which should be set
- * @param loggerName String, which should be used from logger
+ * @param loggerName String, which should be used from logger
*
* @throws GuiBuildException In case of an error
*/