KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ivata > groupware > web > tree > TreeNode


1 /*
2  * Copyright (c) 2001 - 2005 ivata limited.
3  * All rights reserved.
4  * -----------------------------------------------------------------------------
5  * ivata groupware may be redistributed under the GNU General Public
6  * License as published by the Free Software Foundation;
7  * version 2 of the License.
8  *
9  * These programs are free software; you can redistribute them and/or
10  * modify them under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; version 2 of the License.
12  *
13  * These programs are distributed in the hope that they will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  *
17  * See the GNU General Public License in the file LICENSE.txt for more
18  * details.
19  *
20  * If you would like a copy of the GNU General Public License write to
21  *
22  * Free Software Foundation, Inc.
23  * 59 Temple Place - Suite 330
24  * Boston, MA 02111-1307, USA.
25  *
26  *
27  * To arrange commercial support and licensing, contact ivata at
28  * http://www.ivata.com/contact.jsp
29  * -----------------------------------------------------------------------------
30  * $Log: TreeNode.java,v $
31  * Revision 1.4 2005/04/29 02:48:14 colinmacleod
32  * Data bugfixes.
33  * Changed primary key back to Integer.
34  *
35  * Revision 1.3 2005/04/10 20:09:39 colinmacleod
36  * Added new themes.
37  * Changed id type to String.
38  * Changed i tag to em and b tag to strong.
39  * Improved PicoContainerFactory with NanoContainer scripts.
40  *
41  * Revision 1.2 2005/04/09 17:19:10 colinmacleod
42  * Changed copyright text to GPL v2 explicitly.
43  *
44  * Revision 1.1.1.1 2005/03/10 17:50:36 colinmacleod
45  * Restructured ivata op around Hibernate/PicoContainer.
46  * Renamed ivata groupware.
47  *
48  * Revision 1.2 2004/11/03 16:10:12 colinmacleod
49  * Changed todo comments to TODO: all caps.
50  *
51  * Revision 1.1 2004/09/30 15:16:03 colinmacleod
52  * Split off addressbook elements into security subproject.
53  *
54  * Revision 1.2 2004/03/21 21:16:18 colinmacleod
55  * Shortened name to ivata op.
56  *
57  * Revision 1.1.1.1 2004/01/27 20:57:58 colinmacleod
58  * Moved ivata openportal to SourceForge..
59  *
60  * Revision 1.1.1.1 2003/10/13 20:50:07 colin
61  * Restructured portal into subprojects
62  *
63  * Revision 1.1 2003/02/24 19:33:33 colin
64  * moved to jsp
65  *
66  * Revision 1.2 2003/02/04 17:43:46 colin
67  * copyright notice
68  *
69  * Revision 1.1 2002/06/21 11:58:37 colin
70  * restructured com.ivata.groupware.web into seperate subcategories: fornat, javascript, theme and tree.
71  * -----------------------------------------------------------------------------
72  */
73 package com.ivata.groupware.web.tree;
74
75 /**
76  * <p>Create a tree node as used in {@link
77  * com.ivata.groupware.web.DefaultTreeNodeRenderer
78  * DefaultTreeNodeRenderer}. All objects which are used as nodes in {@link
79  * com.ivata.groupware.web.tag.webgui.TreeTag TreeTag} must implement this
80  * interface.</p>
81  *
82  * @since TODO:
83  * @author Colin MacLeod
84  * <a HREF='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
85  * @version $Revision: 1.4 $
86  * @see com.ivata.groupware.web.DefaultTreeNodeRenderer
87  */
88 public interface TreeNode {
89
90     /**
91      * <p>Get a unique identifier for this object.</p>
92      *
93      * @return a unique identifier for this object.
94      *
95      */
96     public Integer JavaDoc getId();
97
98     /**
99      * <p>Get a clear-text name for this object. This should usually be unique
100      * for this object, although this is not necessarily enforced.</p>
101      *
102      * @return a clear-text name for this object.
103      *
104      */
105     public String JavaDoc getName();
106 }
107
Popular Tags