com.technia.tvc.reportgenerator.concurrent

Interface Handle

public interface Handle

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the work.
java.lang.String	getHandleId()
int	getQueuePosition() Returns the position in the queue.
java.util.Iterator<com.technia.tvc.reportgenerator.ObjectRef>	getSourceObjects()
TaskFailure	getTaskFailure() Returns the TaskFailure, if any.
long	getTime()
boolean	isCanceled()
boolean	isComplete()
boolean	isFailure()
boolean	isInactive()
boolean	isPending()
boolean	isRunning()
boolean	isSuccess()
void	release() Releases this instance.
com.technia.tvc.reportgenerator.concurrent.Result	waitForCompletion() Waits for completion.

Method Detail

getTaskFailure

TaskFailure getTaskFailure()

Returns the TaskFailure, if any.

Returns:

Returns the TaskFailure, if any.

getQueuePosition

int getQueuePosition()

Returns the position in the queue.

Returns:

Returns the position in the queue.

getSourceObjects

java.util.Iterator<com.technia.tvc.reportgenerator.ObjectRef> getSourceObjects()

Returns:

Returns all source objects.

Since:

2011.2.2

isComplete

boolean isComplete()

isInactive

boolean isInactive()

isPending

boolean isPending()

isRunning

boolean isRunning()

isSuccess

boolean isSuccess()

isFailure

boolean isFailure()

isCanceled

boolean isCanceled()

cancel

void cancel()

Cancels the work.

waitForCompletion

com.technia.tvc.reportgenerator.concurrent.Result waitForCompletion()

Waits for completion. This is a blocking operation.

Returns:

The result of the report creation. Note: If the report failed to be created or the report was not requested to be created on-demand, the return value will be null.

release

void release()

Releases this instance. This method should be called, once the generated report has been taken care of.

getTime

long getTime()

Returns:

The processing time in milliseconds.

getHandleId

java.lang.String getHandleId()

Returns:

The ID of this handle