com.essbase.api.base

Interface IEssProgressMonitor

All Superinterfaces:

IEssBaseObject

public interface IEssProgressMonitor
extends IEssBaseObject

The IEssProgressMonitor interface.

Version:

1.0, 04/04/2002

Author:

Srini Ranga

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the operation.
com.essbase.api.base.EssException	getException() Gets the exception.
java.lang.Object	getResult() Gets the operation result.
boolean	isDone() Checks if the operation is done.

Method Detail

isDone

boolean isDone()
        throws com.essbase.api.base.EssException

Checks if the operation is done.

Returns:

true if the operation is done.

Throws:

EssException - if an error occurs.

cancel

void cancel()
     throws com.essbase.api.base.EssException

Cancels the operation.

Throws:

EssException - if an error occurs.

getException

com.essbase.api.base.EssException getException()
                                        throws com.essbase.api.base.EssException

Gets the exception.

Returns:

EssException if an error occured during operation execution. null if there is no exception. Invoke this method only if isDone() returns true.

Throws:

EssException - if this method is invoked when isDone() is false.

getResult

java.lang.Object getResult()
                    throws com.essbase.api.base.EssException

Gets the operation result.

Returns:

The operation result. The type of the return value is specified by the operation that returns the progress monitor. null if there is no exception. Invoke this method only if isDone() returns true.

Throws:

EssException - if this method is invoked when isDone() is false.