edu.ksu.cis.projects.bogor.ext.atomicity
Class AtomicModule

java.lang.Object
  edu.ksu.cis.projects.bogor.ext.atomicity.AtomicModule

All Implemented Interfaces:

IModule, Disposable

public final class AtomicModule
extends Object
implements IModule

Version:

CVS $Revision: 1.1 $ $Date: 2005/06/01 03:01:57 $

Author:

Matt Hoosier

Constructor Summary

AtomicModule()

Method Summary

IBacktrackingInfo	beginAtomic(IExtArguments args)
IMessageStore	connect(IBogorConfiguration bc) Connects this modules to other modules.
void	dispose() Remove references.
IBacktrackingInfo	endAtomic(IExtArguments args)
String	getCopyrightNotice() Returns the copyright notice for this module.
IMessageStore	setOptions(String key, Properties options) Sets the options for this module.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AtomicModule

public AtomicModule()

Method Detail

getCopyrightNotice

public String getCopyrightNotice()

Description copied from interface: IModule

Returns the copyright notice for this module.

Specified by:

getCopyrightNotice in interface IModule

Returns:

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

setOptions

public IMessageStore setOptions(String key,
                                Properties options)

Description copied from interface: IModule

Sets the options for this module.

Specified by:

setOptions in interface IModule

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.

beginAtomic

public IBacktrackingInfo beginAtomic(IExtArguments args)

connect

public IMessageStore connect(IBogorConfiguration bc)

Description copied from interface: IModule

Connects this modules to other modules.

Specified by:

connect in interface IModule

Parameters:

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

dispose

public void dispose()

Description copied from interface: Disposable

Remove references. Once called, avoid using this object.

Specified by:

dispose in interface Disposable

endAtomic

public IBacktrackingInfo endAtomic(IExtArguments args)