/******************************************************************************* *******************************************************************************/ package at.gv.egiz.eaaf.core.api.gui; import java.io.InputStream; import javax.servlet.http.HttpServletResponse; import org.apache.velocity.VelocityContext; import at.gv.egiz.eaaf.core.exceptions.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. *

* The parser use the VelocityEngine 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 getTemplate(String viewName) 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. *

* The parser use the VelocityEngine 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 getTemplate(String viewName) 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; /** * Generate a new {@link VelocityContext} and populate it with MOA-ID GUI parameters * * @param config * @return */ public VelocityContext generateVelocityContextFromConfiguration(IGUIBuilderConfiguration config); /** * Load the template from different resources * * @param config * @return An {@link InputStream} but never null. The {@link InputStream} had to be closed be the invoking method * @throws GUIBuildException */ public InputStream getTemplateInputStream(IGUIBuilderConfiguration config) throws GUIBuildException; }