com.enterprisemath.utils.engine

Interface TaskManager

public interface TaskManager

Defines interface for task management.

Note: Adding functions to this interface will NOT be considered as breaking binary compatibility.

Author:

radek.hecl

Method Summary

Modifier and Type	Method and Description
String	getCode() Returns task identification code.
Map<String,String>	getExceptionDetails() Returns details about the exception.
Map<String,String>	getResult() Returns task result.
boolean	isDone() Returns whether task is done.
void	stop() Stops task execution.
void	waitTillDone() Waits until task is done.

Method Detail

getCode

String getCode()

Returns task identification code.

Returns:

task identification code

isDone

boolean isDone()

Returns whether task is done. It doesn't matter in which way the end happened. Task may end up by returning the result, throwing exception or get stopped.

Returns:

whether task is done or not

getResult

Map<String,String> getResult()

Returns task result. Result satisfies the following conditions.

• If task finished normally by returning from the run method, then result is ALWAYS not null (empty map if run method returned null)
• If task is still running, then result is null
• If task thrown an exception, then result is null
• If task has been stopped, then result is null

Returns:

task result or null if result is not available

getExceptionDetails

Map<String,String> getExceptionDetails()

Returns details about the exception. This method returns not null always and only if task execution ended up by exception thrown from the run method. In all other cases returns null.

Returns:

details about the exception or null if there was no exception

stop

void stop()

Stops task execution. Once this method returns, then task is stopped and it cannot produce any result any more. If task already finished or has been stopped, then this method has no effect.

waitTillDone

void waitTillDone()

Waits until task is done. This method blocks calling thread until task is done by any way. Immediate call to isDone method will always return true.