org.qedeq.kernel.bo.service.basis
Interface ModuleServicePluginExecutor

All Superinterfaces:

ServiceCompleteness

All Known Implementing Classes:

DynamicHeuristicCheckerExecutor, FormalProofCheckerExecutor, LoadDirectlyRequiredModulesExecutor, LoadRequiredModulesExecutor, Qedeq2LatexExecutor, Qedeq2UnicodeTextExecutor, Qedeq2Utf8Executor, SimpleProofFinderExecutor, WellFormedCheckerExecutor

public interface ModuleServicePluginExecutor
extends ServiceCompleteness

Represents a plugin execution.

Author:

Michael Meyling

Method Summary

java.lang.Object	executePlugin(InternalModuleServiceCall call, java.lang.Object data) Execute plugin.
boolean	getInterrupted() Was the execution interrupted by the user?
java.lang.String	getLocationDescription() Get description of currently taken action.
double	getVisitPercentage() Get percentage of currently running plugin execution.

Method Detail

executePlugin

java.lang.Object executePlugin(InternalModuleServiceCall call,
                               java.lang.Object data)
                               throws InterruptException

Execute plugin.

Parameters:

call - Service call.

data - Process execution data.

Returns:

Plugin specific resulting object. Might be null.

Throws:

InterruptException - User canceled execution.

getVisitPercentage

double getVisitPercentage()

Get percentage of currently running plugin execution.

Specified by:

getVisitPercentage in interface ServiceCompleteness

Returns:

Number between 0 and 100.

getLocationDescription

java.lang.String getLocationDescription()

Get description of currently taken action.

Specified by:

getLocationDescription in interface ServiceCompleteness

Returns:

We are doing this currently.

getInterrupted

boolean getInterrupted()

Was the execution interrupted by the user?

Returns:

The execution was interrupted.