01: /*
02: * <copyright>
03: *
04: * Copyright 1997-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26: package org.cougaar.glm.execution.eg;
27:
28: public interface Plugin {
29: /**
30: * A name to use in menus and such.
31: **/
32: String getPluginName();
33:
34: /**
35: * Get a description of this plugin.
36: **/
37: String getDescription();
38:
39: /**
40: * Plugins can be parameterized with a string.
41: **/
42: void setParameter(String parameter);
43:
44: /**
45: * Test if this plugin can be configured
46: * @return true if it is possible to configure this plugin (has a GUI)
47: **/
48: boolean isConfigurable();
49:
50: void setEventGenerator(EventGenerator eg);
51:
52: void configure(java.awt.Component frame);
53:
54: /**
55: * Plugins should save and restore their state in a property file.
56: * @param props the Properties map in which the values are saved.
57: * @param prefix the prefix for every property name. The prefix
58: * uniquely identifies the plugin.
59: **/
60: void save(java.util.Properties props, String prefix);
61:
62: void restore(java.util.Properties props, String prefix);
63: }
|