001: /*
002: * Copyright (c) 2001 - 2005 ivata limited.
003: * All rights reserved.
004: * -----------------------------------------------------------------------------
005: * ivata groupware may be redistributed under the GNU General Public
006: * License as published by the Free Software Foundation;
007: * version 2 of the License.
008: *
009: * These programs are free software; you can redistribute them and/or
010: * modify them under the terms of the GNU General Public License
011: * as published by the Free Software Foundation; version 2 of the License.
012: *
013: * These programs are distributed in the hope that they will be useful,
014: * but WITHOUT ANY WARRANTY; without even the implied warranty of
015: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016: *
017: * See the GNU General Public License in the file LICENSE.txt for more
018: * details.
019: *
020: * If you would like a copy of the GNU General Public License write to
021: *
022: * Free Software Foundation, Inc.
023: * 59 Temple Place - Suite 330
024: * Boston, MA 02111-1307, USA.
025: *
026: *
027: * To arrange commercial support and licensing, contact ivata at
028: * http://www.ivata.com/contact.jsp
029: * -----------------------------------------------------------------------------
030: * $Log: TreeNode.java,v $
031: * Revision 1.2 2005/10/11 18:51:39 colinmacleod
032: * Fixed some checkstyle and javadoc issues.
033: *
034: * Revision 1.1 2005/09/29 13:44:03 colinmacleod
035: * Moved to core subproject.
036: *
037: * Revision 1.4 2005/04/29 02:48:14 colinmacleod
038: * Data bugfixes.
039: * Changed primary key back to Integer.
040: *
041: * Revision 1.3 2005/04/10 20:09:39 colinmacleod
042: * Added new themes.
043: * Changed id type to String.
044: * Changed i tag to em and b tag to strong.
045: * Improved PicoContainerFactory with NanoContainer scripts.
046: *
047: * Revision 1.2 2005/04/09 17:19:10 colinmacleod
048: * Changed copyright text to GPL v2 explicitly.
049: *
050: * Revision 1.1.1.1 2005/03/10 17:50:36 colinmacleod
051: * Restructured ivata op around Hibernate/PicoContainer.
052: * Renamed ivata groupware.
053: *
054: * Revision 1.2 2004/11/03 16:10:12 colinmacleod
055: * Changed todo comments to TODO: all caps.
056: *
057: * Revision 1.1 2004/09/30 15:16:03 colinmacleod
058: * Split off addressbook elements into security subproject.
059: *
060: * Revision 1.2 2004/03/21 21:16:18 colinmacleod
061: * Shortened name to ivata op.
062: *
063: * Revision 1.1.1.1 2004/01/27 20:57:58 colinmacleod
064: * Moved ivata openportal to SourceForge..
065: *
066: * Revision 1.1.1.1 2003/10/13 20:50:07 colin
067: * Restructured portal into subprojects
068: *
069: * Revision 1.1 2003/02/24 19:33:33 colin
070: * moved to jsp
071: *
072: * Revision 1.2 2003/02/04 17:43:46 colin
073: * copyright notice
074: *
075: * Revision 1.1 2002/06/21 11:58:37 colin
076: * restructured com.ivata.groupware.web into seperate subcategories: fornat,
077: * javascript, theme and tree.
078: * -----------------------------------------------------------------------------
079: */
080: package com.ivata.groupware.web.tree;
081:
082: /**
083: * <p>Create a tree node as used in {@link
084: * com.ivata.groupware.web.DefaultTreeNodeRenderer
085: * DefaultTreeNodeRenderer}. All objects which are used as nodes in {@link
086: * com.ivata.groupware.web.tag.webgui.TreeTag TreeTag} must implement this
087: * interface.</p>
088: *
089: * @since TODO:
090: * @author Colin MacLeod
091: * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
092: * @version $Revision: 1.2 $
093: * @see com.ivata.groupware.web.DefaultTreeNodeRenderer
094: */
095: public interface TreeNode {
096:
097: /**
098: * <p>Get a unique identifier for this object.</p>
099: *
100: * @return a unique identifier for this object.
101: *
102: */
103: Integer getId();
104:
105: /**
106: * <p>Get a clear-text name for this object. This should usually be unique
107: * for this object, although this is not necessarily enforced.</p>
108: *
109: * @return a clear-text name for this object.
110: *
111: */
112: String getName();
113: }
|