01: /*
02: * Copyright (c) 2001 - 2005 ivata limited.
03: * All rights reserved.
04: * -----------------------------------------------------------------------------
05: * ivata groupware may be redistributed under the GNU General Public
06: * License as published by the Free Software Foundation;
07: * version 2 of the License.
08: *
09: * 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: DisplayValueDO.java,v $
31: * Revision 1.1 2005/09/29 12:50:40 colinmacleod
32: * Restructured NamedDO and TimestampDO classes based around interfaces.
33: *
34: * -----------------------------------------------------------------------------
35: */
36: package com.ivata.groupware.container.persistence;
37:
38: /**
39: * <p>
40: * Any data object which has a unique name for display in lists or choices
41: * should implement this interface.
42: * </p>
43: *
44: * @since ivata groupware 1.0 (2005-09-28)
45: * @author Colin MacLeod
46: * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
47: * @version $Revision: 1.1 $
48: */
49: public interface DisplayValueDO {
50: /**
51: * Return the clear-text description of this object, for use in lists.
52: *
53: * @return Clear-text description of this object, for use in lists.
54: */
55: public abstract String getDisplayValue();
56:
57: }
|