org.qedeq.kernel.bo.module
Interface InternalModuleServiceCall

All Superinterfaces:

java.lang.Comparable, ModuleServiceCall

All Known Implementing Classes:

InternalModuleServiceCallImpl

public interface InternalModuleServiceCall
extends ModuleServiceCall

Information for a service call. Occurs during execution of a org.qedeq.kernel.se.common.ServiceJob.

Author:

Michael Meyling

Method Summary

void	finish(ModuleServiceResult result) Set result state for call and stop.
void	finishError(java.lang.String errorMessage) Set generic failure result for call and stop.
void	finishOk() Set generic success result for call and stop.
Parameters	getConfigParameters() Get global config parameters for service call.
InternalServiceJob	getInternalServiceProcess() Return service process the call was initiated.
Parameters	getParameters() Get call specific parameters for service call.
void	halt(ModuleServiceResult result) Set result state for call and stop.
void	halt(java.lang.String errorMessage) Set generic failure result for call and stop.
void	interrupt() Set failure state for call and stop.
void	pause() Signal an execution pause.
void	resume() Signal execution resume.
void	setAction(java.lang.String action) Set description of currently taken action.
void	setExecutionPercentage(double percentage) Set percentage of currently running plugin execution.
void	setServiceCompleteness(ServiceCompleteness completeness) Set someone who answers completeness questions.

Methods inherited from interface org.qedeq.kernel.bo.common.ModuleServiceCall

getAction, getBeginTime, getConfigParametersString, getDuration, getEndTime, getExecutionPercentage, getId, getLocation, getParametersString, getParentServiceCall, getQedeq, getService, getServiceProcess, getServiceResult, isPaused, isRunning

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getConfigParameters

Parameters getConfigParameters()

Get global config parameters for service call.

Returns:

Service parameter.

getParameters

Parameters getParameters()

Get call specific parameters for service call.

Returns:

Service parameter.

setExecutionPercentage

void setExecutionPercentage(double percentage)

Set percentage of currently running plugin execution.

Parameters:

percentage - Number between 0 and 100.

setServiceCompleteness

void setServiceCompleteness(ServiceCompleteness completeness)

Set someone who answers completeness questions.

Parameters:

completeness - An answer for completeness questions. Might be null.

setAction

void setAction(java.lang.String action)

Set description of currently taken action.

Parameters:

action - We are doing this currently.

getInternalServiceProcess

InternalServiceJob getInternalServiceProcess()

Return service process the call was initiated.

Returns:

Service process for this call.

pause

void pause()

Signal an execution pause.

resume

void resume()

Signal execution resume.

finishOk

void finishOk()

Set generic success result for call and stop. Can only be done if call is still running.

finishError

void finishError(java.lang.String errorMessage)

Set generic failure result for call and stop. Can only be done if call is still running.

Parameters:

errorMessage - Reason for finishing with error.

finish

void finish(ModuleServiceResult result)

Set result state for call and stop. Can only be done if call is still running.

Parameters:

result - Service result.

halt

void halt(ModuleServiceResult result)

Set result state for call and stop. Can only be done if call is still running.

Parameters:

result - Must include reason for halting.

halt

void halt(java.lang.String errorMessage)

Set generic failure result for call and stop. Can only be done if call is still running.

Parameters:

errorMessage - Reason for halting.

interrupt

void interrupt()

Set failure state for call and stop. Can only be done if call is still running.