com.jcorporate.expresso.services.asyncprocess
Interface AsyncProcessResult

All Known Implementing Classes:

DefaultProcessResult

public interface AsyncProcessResult

AsyncProcessResult a wrpper interface for what is handed back to the client when a process is waiting, running, or completed..

Version:

$Revision: 1.2 $ on $Date: 2003/10/01 01:18:37 $

Author:

Michael Rimov

Field Summary

static int	STATUS_COMPLETE Status code for the process is complete
static int	STATUS_FAULT Status code for there has been an error processing the AsyncProcess.
static int	STATUS_PENDING Status code for the process is still waiting in queue.
static int	STATUS_RUNNING Status code for the process is currently running

Method Summary

Throwable	getException() Retrieve the exception that occured during the processing.
AsyncProcess	getOriginalProcess() Get the asynchronous process
Object	getResult() Retrieve the result of the Object
Object	getStatus() Retrieve the status object
int	getStatusCode() Retrieve the status code of the process.

Field Detail

STATUS_PENDING

public static final int STATUS_PENDING

Status code for the process is still waiting in queue.

See Also:

Constant Field Values

STATUS_RUNNING

public static final int STATUS_RUNNING

Status code for the process is currently running

See Also:

Constant Field Values

STATUS_COMPLETE

public static final int STATUS_COMPLETE

Status code for the process is complete

See Also:

Constant Field Values

STATUS_FAULT

public static final int STATUS_FAULT

Status code for there has been an error processing the AsyncProcess. Use getException() to retrieve the actual exception thrown

See Also:

Constant Field Values

Method Detail

getStatusCode

public int getStatusCode()

Retrieve the status code of the process.

Returns:

integer the status code, one of the status fields listed above

getException

public Throwable getException()

Retrieve the exception that occured during the processing. [If one exists]

Returns:

The Exception thrown or null if there is none available.

getResult

public Object getResult()

Retrieve the result of the Object

Returns:

java.lang.Object the result of the processing

getStatus

public Object getStatus()

Retrieve the status object

Returns:

java.lang.Object the status of the object

getOriginalProcess

public AsyncProcess getOriginalProcess()

Get the asynchronous process

Returns:

AsyncProcess the async process object that was originally queued