01: /***
02: * jwma Java WebMail
03: * Copyright (c) 2000-2003 jwma team
04: *
05: * jwma is free software; you can distribute and use this source
06: * under the terms of the BSD-style license received along with
07: * the distribution.
08: ***/package dtw.webmail.model;
09:
10: /**
11: * An interface defining the contract for interaction with
12: * the JwmaContactGroup model.
13: * <p>
14: * The <tt>JwmaContactGroup</tt> allows a view programmer to obtain
15: * information about the contact group to display
16: * items for reading or editing.
17: *
18: * @author Dieter Wimberger
19: * @version 0.9.7 07/02/2003
20: *
21: */
22: public interface JwmaContactGroup {
23:
24: /**
25: * Returns the unique identifier of this <tt>JwmaContactGroup</tt>.
26: *
27: * @return the unique identifier as <tt>String</tt>.
28: */
29: public String getUID();
30:
31: /**
32: * Returns the name of this <tt>JwmaContactGroup</tt>.
33: *
34: * @return the name of this group as <tt>String</tt>.
35: */
36: public String getName();
37:
38: /**
39: * Returns the comments about this <tt>JwmaContactGroup</tt>.
40: *
41: * @return the comments about this group as <tt>String</tt>.
42: */
43: public String getComments();
44:
45: /**
46: * Returns an array of contacts containing all contacts
47: * in this contact group.
48: * <p>
49: * If this contact group does not contain any contacts,
50: * then this method returns an empty array.
51: *
52: * Otherwise it contains one <tt>JwmaContact</tt> for
53: * each entry in this contact group.
54: *
55: * @return an array of <tt>JwmaContact</tt>'s.
56: */
57: public JwmaContact[] listContacts();
58:
59: /**
60: *
61: */
62:
63: }//interface JwmaContactGroup
|