edu.ksu.cis.projects.bogor.module
Interface IModule

All Superinterfaces:

Disposable

All Known Subinterfaces:

IActionTaker, IBacktrackingInfoFactory, IClassLoader, ICounterExampleWriter, IExpEvaluator, IListener, IProgressManager, ISchedulingStrategist, ISearcher, ISelfDescribingModule, IStateAugmenter, IStateFactory, IStateManager, ITransformationFilter, ITransformer, IValueFactory

All Known Implementing Classes:

AbstractProgressManager, AtomicModule, DefaultActionTaker, DefaultBacktrackingInfoFactory, DefaultClassLoader, DefaultCounterExampleWriter, DefaultCounterExampleWriter.DummyProgressManager, DefaultCounterExampleWriter.DummyStateManagerProxy, DefaultCounterExampleWriter.GuidedSchedulingStrategistProxy, DefaultCounterExampleWriter.GuidedSearcherProxy, DefaultExpEvaluator, DefaultSchedulingStrategist, DefaultSearcher, DefaultStateFactory, DefaultStateManager, DefaultTransformer, DefaultValueFactory

public interface IModule
extends Disposable

This interface is the top-level interface for all Bogor modules. It provides mechanisms to get copyright notice, to set module options, and to establish connections between modules.

Version:

CVS $Revision: 1.3 $ $Date: 2004/10/29 18:22:16 $

Author:

Robby

Method Summary

IMessageStore	connect(IBogorConfiguration bc) Connects this modules to other modules.
String	getCopyrightNotice() Returns the copyright notice for this module.
IMessageStore	setOptions(String key, Properties options) Sets the options for this module.

Methods inherited from interface edu.ksu.cis.projects.bogor.util.Disposable

dispose

Method Detail

getCopyrightNotice

String getCopyrightNotice()

Returns the copyright notice for this module.

Returns:

The copyright notice for this module. Returns null if no additional notice is necessary.

setOptions

IMessageStore setOptions(String key,
                         Properties options)

Sets the options for this module.

Parameters:

key - The key (prefix) for this module options. Must be non-null. The key is used for module specific options.

options - The options for all modules. Must be non-null.

connect

IMessageStore connect(IBogorConfiguration bc)

Connects this modules to other modules.

Parameters:

bc - The Bogor configuration containing modules to connect to. Must be non-null.