ClientProgressManager.RunningTask

java.lang.Object
- com.inductiveautomation.ignition.client.util.gui.progress.ClientProgressManager.RunningTask

All Implemented Interfaces:

TaskHandle

Direct Known Subclasses:

ClientProgressManager.ClientRunningTask, ClientProgressManager.GatewayRunningTask

Enclosing class:

ClientProgressManager
```
protected class ClientProgressManager.RunningTask
extends java.lang.Object
implements TaskHandle
```

Constructor Summary

Constructors
Constructor Description

RunningTask()

RunningTask(TaskProgressState state)

RunningTask(java.lang.String uid)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`cancel()`
`void`	`finish(java.lang.Object result)`
`TaskProgressState`	`getCurrentState()`
`java.lang.String`	`getUid()`
`boolean`	`isDominant()`
`protected void`	`notifyStateChanged()`
`void`	`setCurrentState(TaskProgressState state)`
`void`	`setDominant(boolean isDominant)`
`java.lang.Object`	`waitForResult(int timeout)`	Waits for the operation to complete, returning its ret value, or passing along an error.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RunningTask

public RunningTask(java.lang.String uid)

RunningTask

public RunningTask(TaskProgressState state)

RunningTask
```
public RunningTask()
```

Method Detail
- getUid
```
public java.lang.String getUid()
```
  Specified by:
  
  getUid in interface TaskHandle
- isDominant
```
public boolean isDominant()
```
- setDominant
```
public void setDominant(boolean isDominant)
```
- getCurrentState
```
public TaskProgressState getCurrentState()
```
- setCurrentState
```
public void setCurrentState(TaskProgressState state)
```
- notifyStateChanged
```
protected void notifyStateChanged()
```
- waitForResult
```
public java.lang.Object waitForResult(int timeout)
                               throws java.lang.Exception
```
  Waits for the operation to complete, returning its ret value, or passing along an error. The wait time is extended as long as there has been activity- thus an error will be thrown only after timeout has passed with no new activity.
  
  Specified by:
  
  waitForResult in interface TaskHandle
  
  Throws:
  
  java.lang.Exception
- finish
```
public void finish(java.lang.Object result)
```
- cancel
```
public void cancel()
```
  Specified by:
  
  cancel in interface TaskHandle