OAProcess (OA Java Code Documentation)

java.lang.Object
- com.viaoa.process.OAProcess

All Implemented Interfaces:

Runnable
```
public abstract class OAProcess
extends Object
implements Runnable
```
Similiar to a future or promise to track a process.

Author:

vvia

Constructor Summary

Constructors
Constructor and Description

OAProcess()

Constructors
Constructor and Description
`OAProcess()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel(String reason)`
`void`	`done()`
`boolean`	`getBlock()`
`boolean`	`getCanCancel()`
`boolean`	`getCancelled()`
`String`	`getCancelReason()`
`long`	`getCancelTime()`
`long`	`getCreatedTime()`
`int`	`getCurrentStep()`
`String`	`getDescription()`
`long`	`getDoneTime()`
`long`	`getEstimateTime()`
`Exception`	`getException()`
`long`	`getMaxBlockTime()`
`long`	`getMaxTime()`
`String`	`getName()`
`String[]`	`getSteps()`
`int`	`getTotalSteps()`
`boolean`	`isBlockTimedout()`
`boolean`	`isDone()`
`boolean`	`isTimedout()`
`void`	`setBlock(boolean b)`
`void`	`setCanCancel(boolean b)`
`protected void`	`setCurrentStep(int x)`
`void`	`setDescription(String s)`
`protected void`	`setEstimateTime(long x)`
`protected void`	`setException(Exception ex)`
`protected void`	`setMaxBlockTime(long x)`
`void`	`setMaxTime(long x)`
`void`	`setName(String s)`
`void`	`setSteps(String... steps)`
`boolean`	`wasCancelled()`

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

Methods inherited from interface java.lang.Runnable
run

Constructor Detail
- OAProcess
```
public OAProcess()
```

Method Detail

setCanCancel
```
public void setCanCancel(boolean b)
```

getCanCancel
```
public boolean getCanCancel()
```

setBlock
```
public void setBlock(boolean b)
```

getBlock
```
public boolean getBlock()
```

setMaxBlockTime

protected void setMaxBlockTime(long x)

getMaxBlockTime
```
public long getMaxBlockTime()
```

getName
```
public String getName()
```

setName
```
public void setName(String s)
```

getDescription
```
public String getDescription()
```

setDescription
```
public void setDescription(String s)
```

getCreatedTime
```
public long getCreatedTime()
```

cancel
```
public void cancel(String reason)
```

wasCancelled
```
public boolean wasCancelled()
```

getCancelled
```
public boolean getCancelled()
```

getCancelTime
```
public long getCancelTime()
```

getCancelReason
```
public String getCancelReason()
```

done
```
public void done()
```

isDone
```
public boolean isDone()
```

getDoneTime
```
public long getDoneTime()
```

getException
```
public Exception getException()
```

setException

protected void setException(Exception ex)

getSteps
```
public String[] getSteps()
```

setSteps

public void setSteps(String... steps)

getTotalSteps
```
public int getTotalSteps()
```

setCurrentStep
```
protected void setCurrentStep(int x)
```

getCurrentStep
```
public int getCurrentStep()
```

setEstimateTime

protected void setEstimateTime(long x)

getEstimateTime
```
public long getEstimateTime()
```

getMaxTime
```
public long getMaxTime()
```

setMaxTime
```
public void setMaxTime(long x)
```

isBlockTimedout
```
public boolean isBlockTimedout()
```

isTimedout
```
public boolean isTimedout()
```

Class OAProcess

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Runnable

Constructor Detail

OAProcess

Method Detail

setCanCancel

getCanCancel

setBlock

getBlock

setMaxBlockTime

getMaxBlockTime

getName

setName

getDescription

setDescription

getCreatedTime

cancel

wasCancelled

getCancelled

getCancelTime

getCancelReason

done

isDone

getDoneTime

getException

setException

getSteps

setSteps

getTotalSteps

setCurrentStep

getCurrentStep

setEstimateTime

getEstimateTime

getMaxTime

setMaxTime

isBlockTimedout

isTimedout