1 /*
2 * (C) 2002 David Carr david@carr.name
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 */
18
19 package net.sourceforge.mflow.api;
20
21 import java.util.List;
22
23 /***
24 * A collection of Contacts, with an optional name
25 *
26 * @author <a href="mailto:david@carr.name">David Carr</a>
27 * @version $Revision: 1.4 $
28 */
29 public interface ContactGroup {
30 /***
31 * Accessor for the name
32 *
33 * @return the name
34 */
35 String getName();
36
37 /***
38 * Mutator for the name
39 *
40 * @param name the new name
41 */
42 void setName(String name);
43
44 /***
45 * Adds the specified contact to the ContactGroup
46 *
47 * @param c The contact to add.
48 * @return true if the add resulted in a change, false if it did not
49 */
50 boolean add(Contact c);
51
52 /***
53 * Adds the specified contact group to the ContactGroup
54 *
55 * @param cg The contact group to add.
56 * @return true if the add resulted in a change, false if it did not
57 */
58 boolean add(ContactGroup cg);
59
60 /***
61 * Adds the contents of the specified List to the ContactGroup
62 *
63 * @param list the List to add the contents of
64 * @return true if the addAll resulted in a change, false if it did not
65 */
66 boolean addAll(List list);
67
68 /***
69 * @return all of the contacts in the group
70 */
71 Contact[] getContacts();
72
73 /***
74 * @return all of the contact groups contained within the group
75 */
76 ContactGroup[] getGroups();
77
78 /***
79 * @return the number of conntacts and/or contact groups contained
80 */
81 int size();
82 }
This page was automatically generated by Maven