Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.essbase.api.base
Interface IEssProgressMonitor

All Superinterfaces:
  IEssBaseObject

public interface IEssProgressMonitor
extends IEssBaseObject

The IEssProgressMonitor interface.

Method Summary
`void` | `cancel()` Cancels the operation.
`EssException` | `getException()` Gets the exception.
`java.lang.Object` | `getResult()` Gets the operation result.
`boolean` | `isDone()` Checks if the operation is done.

Method Detail

### isDone

    public boolean isDone()
                   throws EssException

  Checks if the operation is done.

  Returns:
    true if the operation is done.
  Throws:
    `EssException` - if an error occurs.

### cancel

    public void cancel()
                throws EssException

  Cancels the operation.

  Throws:
    `EssException` - if an error occurs.

### getException

    public EssException getException()
                              throws 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

    public java.lang.Object getResult()
                               throws 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.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD