AbstractJobEntity (Flowable 6.7.0 API)

java.lang.Object
- org.activiti.engine.impl.persistence.entity.AbstractJobEntity

All Implemented Interfaces:

Serializable, BulkDeleteable, HasRevision, PersistentObject, Job, JobInfo

Direct Known Subclasses:

DeadLetterJobEntity, JobEntity, SuspendedJobEntity, TimerJobEntity
```
public abstract class AbstractJobEntity
extends Object
implements Job, PersistentObject, HasRevision, BulkDeleteable, Serializable
```
Abstract job entity class.

Author:

Tijs Rademakers

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`category`
`protected Date`	`createTime`
`protected ByteArrayRef`	`customValuesByteArrayRef`
`static boolean`	`DEFAULT_EXCLUSIVE`
`static int`	`DEFAULT_RETRIES`
`protected Date`	`duedate`
`protected String`	`elementId`
`protected String`	`elementName`
`protected Date`	`endDate`
`protected ByteArrayRef`	`exceptionByteArrayRef`
`protected String`	`exceptionMessage`
`protected String`	`executionId`
`protected String`	`id`
`protected boolean`	`isExclusive`
`protected String`	`jobHandlerConfiguration`
`protected String`	`jobHandlerType`
`protected String`	`jobType`
`protected int`	`maxIterations`
`protected String`	`processDefinitionId`
`protected String`	`processInstanceId`
`protected String`	`repeat`
`protected int`	`retries`
`protected int`	`revision`
`protected String`	`scopeDefinitionId`
`protected String`	`scopeId`
`protected String`	`scopeType`
`protected String`	`subScopeId`
`protected String`	`tenantId`

Fields inherited from interface org.flowable.job.api.Job
JOB_TYPE_EXTERNAL_WORKER, JOB_TYPE_MESSAGE, JOB_TYPE_TIMER

Constructor Summary

Constructors
Constructor and Description

AbstractJobEntity()

Constructors
Constructor and Description
`AbstractJobEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getCategory()` Get the category for this job.
`String`	`getCorrelationId()` Returns the correlation id of a job.
`Date`	`getCreateTime()` Returns the create datetime of the job.
`String`	`getCustomValues()` Get the custom values.
`Date`	`getDuedate()` Returns the date on which this job is supposed to be processed.
`String`	`getElementId()` Reference to an element identifier or null if none is set.
`String`	`getElementName()` Reference to an element name or null if none is set.
`Date`	`getEndDate()`
`String`	`getExceptionMessage()` Returns the message of the exception that occurred, the last time the job was executed.
`String`	`getExceptionStacktrace()`
`String`	`getExecutionId()` Returns the specific execution on which the job was created.
`String`	`getId()` Returns the unique identifier for this job.
`String`	`getJobHandlerConfiguration()` Get the job handler configuration.
`String`	`getJobHandlerType()` Get the job handler type.
`String`	`getJobType()` Get the job type for this job.
`Object`	`getPersistentState()` Returns a representation of the object, as would be stored in the database.
`String`	`getProcessDefinitionId()` Returns the specific process definition on which the job was created
`String`	`getProcessInstanceId()` x Returns the id of the process instance which execution created the job.
`String`	`getRepeat()`
`int`	`getRetries()` Returns the number of retries this job has left.
`int`	`getRevision()`
`int`	`getRevisionNext()`
`String`	`getScopeDefinitionId()` Reference to a scope definition identifier or null if none is set.
`String`	`getScopeId()` Reference to a scope identifier or null if none is set.
`String`	`getScopeType()` Reference to a scope type or null if none is set.
`String`	`getSubScopeId()` Reference to a sub scope identifier or null if none is set.
`String`	`getTenantId()` Get the tenant identifier for this job.
`boolean`	`isExclusive()` Is the job exclusive?
`void`	`setCategory(String category)`
`void`	`setCreateTime(Date createTime)`
`void`	`setCustomValues(String customValues)`
`void`	`setDuedate(Date duedate)`
`void`	`setElementId(String elementId)`
`void`	`setElementName(String elementName)`
`void`	`setEndDate(Date endDate)`
`void`	`setExceptionMessage(String exceptionMessage)`
`void`	`setExceptionStacktrace(String exception)`
`void`	`setExclusive(boolean isExclusive)`
`void`	`setExecution(ExecutionEntity execution)`
`void`	`setExecutionId(String executionId)`
`void`	`setId(String id)`
`void`	`setJobHandlerConfiguration(String jobHandlerConfiguration)`
`void`	`setJobHandlerType(String jobHandlerType)`
`void`	`setJobType(String jobType)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessInstanceId(String processInstanceId)`
`void`	`setRepeat(String repeat)`
`void`	`setRetries(int retries)`
`void`	`setRevision(int revision)`
`void`	`setScopeDefinitionId(String scopeDefinitionId)`
`void`	`setScopeId(String scopeId)`
`void`	`setScopeType(String scopeType)`
`void`	`setSubScopeId(String subScopeId)`
`void`	`setTenantId(String tenantId)`

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

- Field Detail
  - DEFAULT_EXCLUSIVE
```
public static final boolean DEFAULT_EXCLUSIVE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_RETRIES
```
public static final int DEFAULT_RETRIES
```
    See Also:
    
    Constant Field Values
  - id
```
protected String id
```
  - revision
```
protected int revision
```
  - duedate
```
protected Date duedate
```
  - createTime
```
protected Date createTime
```
  - executionId
```
protected String executionId
```
  - processInstanceId
```
protected String processInstanceId
```
  - processDefinitionId
```
protected String processDefinitionId
```
  - category
```
protected String category
```
  - jobType
```
protected String jobType
```
  - elementId
```
protected String elementId
```
  - elementName
```
protected String elementName
```
  - scopeId
```
protected String scopeId
```
  - subScopeId
```
protected String subScopeId
```
  - scopeType
```
protected String scopeType
```
  - scopeDefinitionId
```
protected String scopeDefinitionId
```
  - isExclusive
```
protected boolean isExclusive
```
  - retries
```
protected int retries
```
  - jobHandlerType
```
protected String jobHandlerType
```
  - jobHandlerConfiguration
```
protected String jobHandlerConfiguration
```
  - maxIterations
```
protected int maxIterations
```
  - repeat
```
protected String repeat
```
  - endDate
```
protected Date endDate
```
  - exceptionByteArrayRef
```
protected final ByteArrayRef exceptionByteArrayRef
```
  - customValuesByteArrayRef
```
protected final ByteArrayRef customValuesByteArrayRef
```
  - exceptionMessage
```
protected String exceptionMessage
```
  - tenantId
```
protected String tenantId
```
- Constructor Detail
  - AbstractJobEntity
```
public AbstractJobEntity()
```
- Method Detail
  - setExecution
```
public void setExecution(ExecutionEntity execution)
```
  - getExceptionStacktrace
```
public String getExceptionStacktrace()
```
  - setExceptionStacktrace
```
public void setExceptionStacktrace(String exception)
```
  - getCustomValues
```
public String getCustomValues()
```
    Description copied from interface: JobInfo
    
    Get the custom values.
    
    Specified by:
    
    getCustomValues in interface JobInfo
  - setCustomValues
```
public void setCustomValues(String customValues)
```
  - getPersistentState
```
public Object getPersistentState()
```
    Description copied from interface: PersistentObject
    
    Returns a representation of the object, as would be stored in the database. Used when deciding if updates have occurred to the object or not since it was last loaded.
    
    Specified by:
    
    getPersistentState in interface PersistentObject
  - getRevisionNext
```
public int getRevisionNext()
```
    Specified by:
    
    getRevisionNext in interface HasRevision
  - getId
```
public String getId()
```
    Description copied from interface: JobInfo
    
    Returns the unique identifier for this job.
    
    Specified by:
    
    getId in interface PersistentObject
    
    Specified by:
    
    getId in interface JobInfo
  - setId
```
public void setId(String id)
```
    Specified by:
    
    setId in interface PersistentObject
  - getRevision
```
public int getRevision()
```
    Specified by:
    
    getRevision in interface HasRevision
  - setRevision
```
public void setRevision(int revision)
```
    Specified by:
    
    setRevision in interface HasRevision
  - getDuedate
```
public Date getDuedate()
```
    Description copied from interface: Job
    
    Returns the date on which this job is supposed to be processed.
    
    Specified by:
    
    getDuedate in interface Job
  - setDuedate
```
public void setDuedate(Date duedate)
```
  - getCreateTime
```
public Date getCreateTime()
```
    Description copied from interface: Job
    
    Returns the create datetime of the job.
    
    Specified by:
    
    getCreateTime in interface Job
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
  - getExecutionId
```
public String getExecutionId()
```
    Description copied from interface: Job
    
    Returns the specific execution on which the job was created.
    
    Specified by:
    
    getExecutionId in interface Job
  - setExecutionId
```
public void setExecutionId(String executionId)
```
  - getRetries
```
public int getRetries()
```
    Description copied from interface: JobInfo
    
    Returns the number of retries this job has left. Whenever the jobexecutor fails to execute the job, this value is decremented. When it hits zero, the job is supposed to be dead and not retried again (ie a manual retry is required then).
    
    Specified by:
    
    getRetries in interface JobInfo
  - setRetries
```
public void setRetries(int retries)
```
  - getProcessInstanceId
```
public String getProcessInstanceId()
```
    Description copied from interface: Job
    
    x Returns the id of the process instance which execution created the job.
    
    Specified by:
    
    getProcessInstanceId in interface Job
  - setProcessInstanceId
```
public void setProcessInstanceId(String processInstanceId)
```
  - isExclusive
```
public boolean isExclusive()
```
    Description copied from interface: Job
    
    Is the job exclusive?
    
    Specified by:
    
    isExclusive in interface Job
  - setExclusive
```
public void setExclusive(boolean isExclusive)
```
  - getProcessDefinitionId
```
public String getProcessDefinitionId()
```
    Description copied from interface: Job
    
    Returns the specific process definition on which the job was created
    
    Specified by:
    
    getProcessDefinitionId in interface Job
  - setProcessDefinitionId
```
public void setProcessDefinitionId(String processDefinitionId)
```
  - getCategory
```
public String getCategory()
```
    Description copied from interface: Job
    
    Get the category for this job.
    
    Specified by:
    
    getCategory in interface Job
  - setCategory
```
public void setCategory(String category)
```
  - getJobType
```
public String getJobType()
```
    Description copied from interface: Job
    
    Get the job type for this job.
    
    Specified by:
    
    getJobType in interface Job
  - setJobType
```
public void setJobType(String jobType)
```
  - getElementId
```
public String getElementId()
```
    Description copied from interface: Job
    
    Reference to an element identifier or null if none is set.
    
    Specified by:
    
    getElementId in interface Job
  - setElementId
```
public void setElementId(String elementId)
```
  - getElementName
```
public String getElementName()
```
    Description copied from interface: Job
    
    Reference to an element name or null if none is set.
    
    Specified by:
    
    getElementName in interface Job
  - setElementName
```
public void setElementName(String elementName)
```
  - getScopeId
```
public String getScopeId()
```
    Description copied from interface: Job
    
    Reference to a scope identifier or null if none is set.
    
    Specified by:
    
    getScopeId in interface Job
  - setScopeId
```
public void setScopeId(String scopeId)
```
  - getSubScopeId
```
public String getSubScopeId()
```
    Description copied from interface: Job
    
    Reference to a sub scope identifier or null if none is set.
    
    Specified by:
    
    getSubScopeId in interface Job
  - setSubScopeId
```
public void setSubScopeId(String subScopeId)
```
  - getScopeType
```
public String getScopeType()
```
    Description copied from interface: Job
    
    Reference to a scope type or null if none is set.
    
    Specified by:
    
    getScopeType in interface Job
  - setScopeType
```
public void setScopeType(String scopeType)
```
  - getScopeDefinitionId
```
public String getScopeDefinitionId()
```
    Description copied from interface: Job
    
    Reference to a scope definition identifier or null if none is set.
    
    Specified by:
    
    getScopeDefinitionId in interface Job
  - setScopeDefinitionId
```
public void setScopeDefinitionId(String scopeDefinitionId)
```
  - getJobHandlerType
```
public String getJobHandlerType()
```
    Description copied from interface: JobInfo
    
    Get the job handler type.
    
    Specified by:
    
    getJobHandlerType in interface JobInfo
  - setJobHandlerType
```
public void setJobHandlerType(String jobHandlerType)
```
  - getJobHandlerConfiguration
```
public String getJobHandlerConfiguration()
```
    Description copied from interface: JobInfo
    
    Get the job handler configuration.
    
    Specified by:
    
    getJobHandlerConfiguration in interface JobInfo
  - setJobHandlerConfiguration
```
public void setJobHandlerConfiguration(String jobHandlerConfiguration)
```
  - getRepeat
```
public String getRepeat()
```
  - setRepeat
```
public void setRepeat(String repeat)
```
  - getEndDate
```
public Date getEndDate()
```
  - setEndDate
```
public void setEndDate(Date endDate)
```
  - getExceptionMessage
```
public String getExceptionMessage()
```
    Description copied from interface: JobInfo
    
    Returns the message of the exception that occurred, the last time the job was executed. Returns null when no exception occurred. To get the full exception stacktrace, use ManagementService#getJobExceptionStacktrace(String)
    
    Specified by:
    
    getExceptionMessage in interface JobInfo
  - setExceptionMessage
```
public void setExceptionMessage(String exceptionMessage)
```
  - getTenantId
```
public String getTenantId()
```
    Description copied from interface: JobInfo
    
    Get the tenant identifier for this job.
    
    Specified by:
    
    getTenantId in interface JobInfo
  - setTenantId
```
public void setTenantId(String tenantId)
```
  - getCorrelationId
```
public String getCorrelationId()
```
    Description copied from interface: Job
    
    Returns the correlation id of a job. The same job can be moved around and have its technical id changed. This id allows tracking that job.
    
    Specified by:
    
    getCorrelationId in interface Job

Class AbstractJobEntity

Field Summary

Fields inherited from interface org.flowable.job.api.Job

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_EXCLUSIVE

DEFAULT_RETRIES

id

revision

duedate

createTime

executionId

processInstanceId

processDefinitionId

category

jobType

elementId

elementName

scopeId

subScopeId

scopeType

scopeDefinitionId

isExclusive

retries

jobHandlerType

jobHandlerConfiguration

maxIterations

repeat

endDate

exceptionByteArrayRef

customValuesByteArrayRef

exceptionMessage

tenantId

Constructor Detail

AbstractJobEntity

Method Detail

setExecution

getExceptionStacktrace

setExceptionStacktrace

getCustomValues

setCustomValues

getPersistentState

getRevisionNext

getId

setId

getRevision

setRevision

getDuedate

setDuedate

getCreateTime

setCreateTime

getExecutionId

setExecutionId

getRetries

setRetries

getProcessInstanceId

setProcessInstanceId

isExclusive

setExclusive

getProcessDefinitionId

setProcessDefinitionId

getCategory

setCategory

getJobType

setJobType

getElementId

setElementId

getElementName

setElementName

getScopeId

setScopeId

getSubScopeId

setSubScopeId

getScopeType

setScopeType

getScopeDefinitionId

setScopeDefinitionId

getJobHandlerType