ProcessStatus (broadleaf-jobs-events 2.0.3-SNAPSHOT API)

All Known Implementing Classes:

ProcessStatusImpl
```
public interface ProcessStatus
```
Represents the progress status and identity of an asynchronous thread of execution.

Author:

Jeff Fischer

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Any additional, descriptive information about the process
`Long`	`getExecutionId()` Relates to the primary key of another, arbitrary entity.
`String`	`getExecutionType()` Relates to a descriptive type that ties this to an asynchronous thread of execution.
`String`	`getFriendlyName()` Name used by the system in a human-readable format
`Long`	`getId()` Primary key
`Boolean`	`getIsArchived()` Whether or not this ProcessStatus is considered to be archived.
`Boolean`	`getIsPaused()` Whether or not this ProcessStatus is considered to be in a paused state.
`Date`	`getLastUpdated()` The last time this ProcessStatus was touched by the KeepAlive process.
`String`	`getName()` Name used by the system to identify the process
`Double`	`getPercentComplete()` The level of completion of the asynchronous thread of execution currently achieved.
`Long`	`getProcessId()` A system generated identifier for the process
`void`	`setDescription(String description)`
`void`	`setExecutionId(Long executionId)`
`void`	`setExecutionType(String executionType)`
`void`	`setFriendlyName(String friendlyName)`
`void`	`setId(Long id)`
`void`	`setIsArchived(Boolean isPaused)`
`void`	`setIsPaused(Boolean isPaused)`
`void`	`setLastUpdated(Date lastUpdated)`
`void`	`setName(String name)`
`void`	`setPercentComplete(Double percentComplete)`
`void`	`setProcessId(Long processId)`

- Method Detail
  - getId
```
Long getId()
```
    Primary key
    
    Returns:
  - setId
```
void setId(Long id)
```
  - getName
```
String getName()
```
    Name used by the system to identify the process
    
    Returns:
  - setName
```
void setName(String name)
```
  - getFriendlyName
```
String getFriendlyName()
```
    Name used by the system in a human-readable format
    
    Returns:
  - setFriendlyName
```
void setFriendlyName(String friendlyName)
```
  - getDescription
```
String getDescription()
```
    Any additional, descriptive information about the process
    
    Returns:
  - setDescription
```
void setDescription(String description)
```
  - getProcessId
```
Long getProcessId()
```
    A system generated identifier for the process
    
    Returns:
  - setProcessId
```
void setProcessId(Long processId)
```
  - getExecutionId
```
Long getExecutionId()
```
    Relates to the primary key of another, arbitrary entity. Should be used by an asynchronous thread of execution to associate this process with key entity from that process. This is generally set via ProcessManager.setExecution(Long, String).
    
    Returns:
  - setExecutionId
```
void setExecutionId(Long executionId)
```
  - getExecutionType
```
String getExecutionType()
```
    Relates to a descriptive type that ties this to an asynchronous thread of execution. Using executionType and getExecutionId() in tandem allow for pinpointing a particular ProcessStatus instance for a given asynchronous thread of execution. This is generally set via ProcessManager.setExecution(Long, String).
    
    Returns:
  - setExecutionType
```
void setExecutionType(String executionType)
```
  - getPercentComplete
```
Double getPercentComplete()
```
    The level of completion of the asynchronous thread of execution currently achieved. This is generally updated by the asynchronous thread of execution via ProcessManager.setProgress(long, long).
    This will return the decimal percentage. For display purposes this will likely need to be multiplied by 100
    
    Returns:
  - setPercentComplete
```
void setPercentComplete(Double percentComplete)
```
  - getLastUpdated
```
Date getLastUpdated()
```
    The last time this ProcessStatus was touched by the KeepAlive process.
    
    Returns:
    
    See Also:
    
    KeepAliveWorkerImpl
  - setLastUpdated
```
void setLastUpdated(Date lastUpdated)
```
  - getIsPaused
```
Boolean getIsPaused()
```
    Whether or not this ProcessStatus is considered to be in a paused state. Paused processes are considered to be no longer processing and are in a holding state waiting for an arbitrary action to be taken to resume the work being done. This is useful for processes that that pause/resume logic. This is generally set via ProcessManager.pauseProcess().
    
    Returns:
  - setIsPaused
```
void setIsPaused(Boolean isPaused)
```
  - getIsArchived
```
Boolean getIsArchived()
```
    Whether or not this ProcessStatus is considered to be archived. Archived processes are considered not "live" and are only intended for historical data. Archived processes are purged from the system completely after a configurable amount of time (AbandonedProcessWorkerImpl.abandonedPurgeThresholdSeconds)
    
    Returns:
  - setIsArchived
```
void setIsArchived(Boolean isPaused)
```

Interface ProcessStatus

Method Summary

Method Detail

getId

setId

getName

setName

getFriendlyName

setFriendlyName

getDescription

setDescription

getProcessId

setProcessId

getExecutionId

setExecutionId

getExecutionType

setExecutionType

getPercentComplete

setPercentComplete

getLastUpdated

setLastUpdated

getIsPaused

setIsPaused

getIsArchived

setIsArchived