com.sssw.cm.api
Interface EbiTool

All Superinterfaces:

Serializable

All Known Subinterfaces:

EbiDataTransfer, EbiExporter, EbiImporter

public interface EbiTool

extends Serializable

A generic interface describing a programmatic tool.

Since:

v.4.0

Method Summary

void	clearAll() Removes any internal state within the tool object: any tool settings specified via the setter methods; any input validation errors and warnings; any execution errors and warnings; any results.
void	clearResults() Removes any results held by the tool object after it executes.
void	clearSettings() Removes any settings specified on the tool via the setter methods.
long	execute(EbiContext context) Executes the operation.
boolean	isInputSet() Tells whether the tool has been supplied with an input and is ready to execute.

Method Detail

isInputSet

public boolean isInputSet()

Tells whether the tool has been supplied with an input and is ready to execute.

Returns:

true if the tool has been supplied with an input and is ready to execute

execute

public long execute(EbiContext context)
             throws EboUnrecoverableSystemException,
                    EboSecurityException

Executes the operation.

Parameters:

context - the context

Returns:

the number of milliseconds it took for the operation to complete

Throws:

EboUnrecoverableSystemException - on an unrecoverable error

EboSecurityException - on a security error

clearResults

public void clearResults()

Removes any results held by the tool object after it executes.

clearSettings

public void clearSettings()

Removes any settings specified on the tool via the setter methods.

clearAll

public void clearAll()

Removes any internal state within the tool object:

• any tool settings specified via the setter methods;
• any input validation errors and warnings;
• any execution errors and warnings;
• any results.