org.qedeq.kernel.bo.common
Interface ModuleServiceCall

All Superinterfaces:

java.lang.Comparable

All Known Subinterfaces:

InternalModuleServiceCall

All Known Implementing Classes:

InternalModuleServiceCallImpl

public interface ModuleServiceCall
extends java.lang.Comparable

Information for a service call. Occurs during execution of a ServiceJob.

Author:

Michael Meyling

Method Summary

java.lang.String	getAction() Get description of currently taken action.
long	getBeginTime() Get timestamp for service start.
java.lang.String	getConfigParametersString() Get global config parameter for service call as string.
long	getDuration() Get milliseconds the call was working and not pausing.
long	getEndTime() Get timestamp for service stop.
double	getExecutionPercentage() Get percentage of currently running plugin execution.
long	getId() Get call id.
java.lang.String	getLocation() Where are we now.
java.lang.String	getParametersString() Get call specific parameters for service call as string.
ModuleServiceCall	getParentServiceCall() Return parent service call if any.
QedeqBo	getQedeq() Get QEDEQ module we work on.
Service	getService() Get service we work for.
ServiceJob	getServiceProcess() Return service process the call was initiated by.
ModuleServiceResult	getServiceResult() Result of service execution.
boolean	isPaused() Is the execution currently paused because we are waiting for another process.
boolean	isRunning() Is this service still running? This is also true if the process is paused.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getQedeq

QedeqBo getQedeq()

Get QEDEQ module we work on.

Returns:

QEDEQ module.

getService

Service getService()

Get service we work for.

Returns:

service

getConfigParametersString

java.lang.String getConfigParametersString()

Get global config parameter for service call as string.

Returns:

Service parameter.

getParametersString

java.lang.String getParametersString()

Get call specific parameters for service call as string.

Returns:

Service parameters.

getBeginTime

long getBeginTime()

Get timestamp for service start.

Returns:

Service start timestamp.

getEndTime

long getEndTime()

Get timestamp for service stop.

Returns:

Service stop timestamp.

getDuration

long getDuration()

Get milliseconds the call was working and not pausing.

Returns:

Work milliseconds.

getParentServiceCall

ModuleServiceCall getParentServiceCall()

Return parent service call if any.

Returns:

Parent service call. Might be null.

getServiceProcess

ServiceJob getServiceProcess()

Return service process the call was initiated by.

Returns:

Service process for this call.

isRunning

boolean isRunning()

Is this service still running? This is also true if the process is paused.

Returns:

Still running?

isPaused

boolean isPaused()

Is the execution currently paused because we are waiting for another process.

Returns:

Are we waiting?

getExecutionPercentage

double getExecutionPercentage()

Get percentage of currently running plugin execution.

Returns:

Number between 0 and 100.

getAction

java.lang.String getAction()

Get description of currently taken action.

Returns:

We are doing this currently.

getLocation

java.lang.String getLocation()

Where are we now.

Returns:

Location description.

getServiceResult

ModuleServiceResult getServiceResult()

Result of service execution.

Returns:

Result. Might be null.

getId

long getId()

Get call id.

Returns:

Service call identifying number.