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 * Base interface for all MsgFlow components.
23 * Classes should implement a sub-interface of this interface, such as
24 * MsgReceiver or MsgSource
25 *
26 * @author <a href="mailto:david@carr.name">David Carr</a>
27 * @version $Revision: 1.3 $
28 */
29 public interface MsgFlowComponent extends Configurable, Iconable {
30 /***
31 * Accessor for name property; Provides a way for the user to specify a
32 * user-friendly name for an instance of a component. If the name is the same
33 * as the default name for the component, the component is free to change the
34 * name when other properties are changed.
35 *
36 * @return the name of the instance
37 */
38 String getName();
39
40 /***
41 * Mutator for name property; Provides a way for the user to specify a
42 * user-friendly name for an instance of a component.
43 *
44 * @param aName the new name to set
45 */
46 void setName(String aName);
47 }
This page was automatically generated by Maven