1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2000 William Chesters
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 * William Chesters <williamc@paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45
46 package org.melati.admin;
47
48 import org.melati.Melati;
49 import org.melati.template.MarkupLanguage;
50
51 /**
52 * An interface that allows the editting and display of an object
53 * to be extended.
54 * To process the object in a special way your template should use
55 * a method other than <code>Update</code>.
56 */
57
58 public interface AdminSpecialised {
59
60 /**
61 * Perform the specialised function and return the name of the
62 * template presenting the results.
63 * Return null if not used.
64 *
65 * @see org.melati.admin.Admin
66 * @param melati the current {@link Melati}
67 * @param markupLanguage the current {@link MarkupLanguage}
68 * @return the name of a special template or null if not used
69 * @throws Exception if anything goes wrong
70 */
71 String adminHandle (Melati melati, MarkupLanguage markupLanguage)
72 throws Exception;
73
74 /**
75 * Returns the name of a templet which provides access to the
76 * specialised functionality.
77 * The results of the template are currently included at the bottom of the
78 * standard edit page.
79 *
80 * see also org.melati.admin.Edit.wm
81 * @see org.melati.admin.AdminUtils
82 * @param melati the current {@link Melati}
83 * @param markupLanguage the current {@link MarkupLanguage}
84 * @return the name of a special templet or null if not used
85 * @throws Exception if anything goes wrong
86 */
87 String adminSpecialFacilities (Melati melati, MarkupLanguage markupLanguage)
88 throws Exception;
89 }