OAProcess (com.viaoa:oa-core 3.7.12 API)

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

All Implemented Interfaces:

Runnable
```
public class OAProcess
extends Object
implements Runnable
```
Similar to a future or promise to track and manage a running 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
`boolean`	`confirmRequestToCancel()` This is used to check if requestedToCancel=true, and if so will call setWasCancelled=true and return true.
`boolean`	`getAllowCancel()`
`boolean`	`getBlock()`
`String`	`getCancelledReason()`
`long`	`getCreatedTime()`
`int`	`getCurrentStep()`
`String`	`getDescription()`
`boolean`	`getDone()`
`String`	`getDoneMessage()`
`long`	`getDoneTime()`
`long`	`getEstimateTime()`
`Exception`	`getException()`
`long`	`getMaxBlockTime()`
`long`	`getMaxTime()`
`String`	`getName()`
`boolean`	`getPause()`
`String`	`getRequestCancelReason()`
`long`	`getRequestCancelTime()`
`boolean`	`getRequestedToCancel()`
`String`	`getStatus()`
`String[]`	`getSteps()`
`int`	`getTotalSteps()`
`boolean`	`getWasCancelled()` Check to see if this process wasCancelled=true.
`boolean`	`isBlockTimedout()`
`boolean`	`isPaused()`
`boolean`	`isTimedout()`
`void`	`requestCancel(String reason)`
`void`	`run()`
`void`	`setAllowCancel(boolean b)`
`void`	`setBlock(boolean b)`
`void`	`setCancelledReason(String s)`
`void`	`setCurrentStep(int x)`
`void`	`setDescription(String s)`
`void`	`setDone()`
`void`	`setDoneMessage(String s)`
`protected void`	`setEstimateTime(long x)`
`void`	`setException(Exception ex)`
`protected void`	`setMaxBlockTime(long x)`
`void`	`setMaxTime(long x)`
`void`	`setName(String s)`
`void`	`setPause(boolean b)`
`void`	`setStatus(String s)`
`void`	`setSteps(String... steps)`
`void`	`setWasCancelled(boolean b)`

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

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

Method Detail

setAllowCancel

public void setAllowCancel(boolean b)

getAllowCancel
```
public boolean getAllowCancel()
```

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)
```

getStatus
```
public String getStatus()
```

setStatus
```
public void setStatus(String s)
```

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

getRequestedToCancel
```
public boolean getRequestedToCancel()
```

requestCancel

public void requestCancel(String reason)

getRequestCancelReason

public String getRequestCancelReason()

getRequestCancelTime
```
public long getRequestCancelTime()
```

confirmRequestToCancel
```
public boolean confirmRequestToCancel()
```
This is used to check if requestedToCancel=true, and if so will call setWasCancelled=true and return true. Otherwise, returns false (no request to cancel has been made).

setWasCancelled

public void setWasCancelled(boolean b)

getWasCancelled
```
public boolean getWasCancelled()
```
Check to see if this process wasCancelled=true. Use confirmRequestCancel so that a requestToCancel can be used to then have process cancelled.

getCancelledReason
```
public String getCancelledReason()
```

setCancelledReason

public void setCancelledReason(String s)

setDone
```
public void setDone()
```

getDone
```
public boolean getDone()
```

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

getDoneMessage
```
public String getDoneMessage()
```

setDoneMessage
```
public void setDoneMessage(String s)
```

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

setException

public void setException(Exception ex)

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

setSteps

public void setSteps(String... steps)

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

setCurrentStep
```
public 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()
```

setPause
```
public void setPause(boolean b)
```

isPaused
```
public boolean isPaused()
```

getPause
```
public boolean getPause()
```

run
```
public void run()
```
Specified by:

run in interface Runnable

Class OAProcess

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OAProcess

Method Detail

setAllowCancel

getAllowCancel

setBlock

getBlock

setMaxBlockTime

getMaxBlockTime

getName

setName

getDescription

setDescription

getStatus

setStatus

getCreatedTime

getRequestedToCancel

requestCancel

getRequestCancelReason

getRequestCancelTime

confirmRequestToCancel

setWasCancelled

getWasCancelled

getCancelledReason

setCancelledReason

setDone

getDone

getDoneTime

getDoneMessage

setDoneMessage

getException

setException

getSteps

setSteps

getTotalSteps

setCurrentStep

getCurrentStep

setEstimateTime

getEstimateTime

getMaxTime

setMaxTime

isBlockTimedout

isTimedout

setPause

isPaused

getPause

run