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 /***
22 * Interface for incoming Msg folders
23 *
24 * @author <a href="mailto:david@carr.name">David Carr</a>
25 * @version $Revision: 1.4 $
26 */
27 public interface ReceiveFolder extends MsgFolder, MsgReceiver {
28 /***
29 * Adds a child folder
30 *
31 * @param child the folder to add as a child
32 */
33 void addChild(MsgFolder child);
34
35 /***
36 * Removes a child folder
37 *
38 * @param child the folder to remove as a child
39 */
40 void removeChild(MsgFolder child);
41
42 /***
43 * Accessor for all the children of this folder
44 *
45 * @return an array of MsgFolders
46 */
47 MsgFolder[] getChild();
48
49 /***
50 * Mutator for all the children of this folder
51 *
52 * @param children an array of the new MsgFolders to be children of this
53 * folder
54 */
55 void setChild(MsgFolder[] children);
56
57 /***
58 * Accessor for a single child folder
59 *
60 * @return the folder at the specified index
61 * @param index the index of the folder
62 */
63 MsgFolder getChild(int index);
64
65 /***
66 * Mutator for a single child folder
67 *
68 * @param index the index
69 * @param child the folder to set at the specified index
70 */
71 void setChild(int index, MsgFolder child);
72 }
This page was automatically generated by Maven