WebModule


1   /*
2    * Copyright (c) 2006 - 2007 OpenSubsystems s.r.o. Slovak Republic. All rights reserved.
3    * 
4    * Project: OpenSubsystems
5    * 
6    * $Id: WebModule.java,v 1.5 2007/01/07 06:14:09 bastafidli Exp $
7    * 
8    * This program is free software; you can redistribute it and/or modify
9    * it under the terms of the GNU General Public License as published by
10   * the Free Software Foundation; version 2 of the License. 
11   * 
12   * This program is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   * GNU General Public License for more details.
16   * 
17   * You should have received a copy of the GNU General Public License
18   * along with this program; if not, write to the Free Software
19   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
20   */
21   
22  package org.opensubsystems.core.www;
23  
24  /**
25   * Interface representing web module which is a module of an application, which
26   * has distinct section in a web user interface and can be switched to and from. 
27   * 
28   * @version $Id: WebModule.java,v 1.5 2007/01/07 06:14:09 bastafidli Exp $
29   * @author Julian Legeny
30   * @code.reviewer Miro Halas
31   * @code.reviewed 1.3 2006/04/20 00:05:44 jlegeny
32   */
33  public interface WebModule
34  {
35     /**
36      * Get user friendly name UNIQUE name of the module.
37      * 
38      * @return String
39      */
40     String   getName(
41     );
42     
43     /**
44      * Get user friendly UNIQUE name that will be displayed on the tab (GUI).
45      * 
46      * @return String
47      */
48     String   getTabName(
49     );
50     
51     /**
52      * Get tooltip that will be displayed for particular module on GUI.
53      * 
54      * @return String
55      */
56     String   getTooltip(
57     );
58  
59     /**
60      * Get URL of the module.
61      * 
62      * @return String
63      */
64     String   getURL(
65     );
66  
67     /**
68      * Set up URL of the module.
69      * 
70      * @param strURL - URL of the module 
71      */
72     void setURL(
73        String   strURL
74     );
75  }
76
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags