1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2005 Tim Pizey
6 *
7 * Part of Melati (http://melati.org), a framework for the rapid
8 * development of clean, maintainable web applications.
9 *
10 * Melati is free software; Permission is granted to copy, distribute
11 * and/or modify this software under the terms either:
12 *
13 * a) the GNU General Public License as published by the Free Software
14 * Foundation; either version 2 of the License, or (at your option)
15 * any later version,
16 *
17 * or
18 *
19 * b) any version of the Melati Software License, as published
20 * at http://melati.org
21 *
22 * You should have received a copy of the GNU General Public License and
23 * the Melati Software License along with this program;
24 * if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 * GNU General Public License and visit http://melati.org to obtain the
27 * Melati Software License.
28 *
29 * Feel free to contact the Developers of Melati (http://melati.org),
30 * if you would like to work out a different arrangement than the options
31 * outlined here. It is our intention to allow Melati to be used by as
32 * wide an audience as possible.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * Contact details for copyright holder:
40 *
41 * Tim Pizey <timp@paneris.org>
42 * http://paneris.org/~timp
43 */
44
45 package org.melati.template;
46
47 import javax.servlet.http.HttpSession;
48 import org.melati.servlet.MultipartFormField;
49
50 /**
51 * Interface for a Template engine context for use with Melati
52 * and servlets.
53 */
54
55 public interface ServletTemplateContext extends TemplateContext {
56
57 /**
58 * Get a field from an HTML Form.
59 *
60 * @param s the field's name
61 * @return the field value, null if not set
62 */
63 String getFormField(String s);
64
65 /**
66 * Get a multi-part field from an HTML form.
67 *
68 * @param s the field's name
69 * @return the field's value
70 */
71 MultipartFormField getMultipartFormField(String s);
72
73 /**
74 * Get the {@link HttpSession} .
75 *
76 * @return the current HttpSession
77 */
78 HttpSession getSession();
79
80 }