/*******************************************************************************
 *******************************************************************************/
package at.gv.egiz.eaaf.core.api.gui;

import java.io.InputStream;
import java.util.Map;

/**
 * @author tlenz
 *
 */
public interface IGUIBuilderConfiguration {
	
	
	/**
	 * Define the name of the template (with suffix) which should be used
	 * 
	 * @return templatename, but never null
	 */
	public String getViewName();
	
	/**
	 * Define the parameters, which should be evaluated in the template
	 * 
	 * @return Map of parameters, which should be added to template
	 */
	public Map<String, Object> getViewParameters();
	
	
	/**
	 * Get a specific classpath template-directory prefix, which is used 
	 *  to load a template from classpath by using <code>ClassLoader.getResourceAsStream(...)</code>  
	 * 
	 * @return Classpath directory, or null if the default directory should be used
	 */
	public String getClasspathTemplateDir();
		
	/** 
	 * Get the GUI template with a specific name
	 * 
	 * @param viewName Name of the template
	 * @return Tempate as <code>InputStream</code>, or null if default getTemplate method should be used  
	 */
	public InputStream getTemplate(String viewName);
	
	/**
	 * Get the contentType, which should be set in HTTP response
	 * <br><br>
	 * <b>DefaultValue:</b> text/html;charset=UTF-8
	 * 
	 * @return ContentType, or null if default ContentType should be used.
	 */
	public String getDefaultContentType();
}