Source code: com/dghda/kent/KentModule.java
1 /* Copyright (C) 2001 Duane Griffin <duanegriffin@users.sourceforge.net>
2 This file is part of Kent.
3
4 Kent is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
8
9 Kent is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 General Public License for more details.
13
14 You should have received a copy of the GNU General Public
15 License along with Kent; see the file COPYING. If not,
16 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA.
18 */
19
20 package com.dghda.kent;
21
22 /** Kent modules have configurations and a way to resolve external XML entities. */
23 public interface KentModule extends com.dghda.module.Module {
24
25 /** The name of the property containing the module name. */
26 static final public String REPORT_ID = "com.dghda.kent.ReportID";
27
28 /** The name of the property containing the selected report output format. */
29 static final public String FORMAT_ID = "com.dghda.kent.ResultFormatID";
30
31 /** The name of the property containing the selected report actions. */
32 static final public String ACTION_ID = "com.dghda.kent.ActionIDs";
33
34 /** The configuration option that contains the authenticated use name, if any. */
35 public static final String AUTHENTICATED_USER = "com.dghda.kent.AuthenticatedUser";
36
37 /**
38 Return an XML document describing the configuration options for the module.
39 Configuration options themselves may change depending on the current configuration.
40 The XML should conform to the DTD contained in the file dtd/kentconfig.dtd.
41 */
42 public String getConfigurationOptions (java.util.Properties config);
43 }