JobEntity (camunda BPM - Release Root 7.0.5-ee API)

java.lang.Object
- org.camunda.bpm.engine.impl.persistence.entity.JobEntity

All Implemented Interfaces:

Serializable, HasRevision, PersistentObject, Job

Direct Known Subclasses:

MessageEntity, TimerEntity
```
public abstract class JobEntity
extends Object
implements Serializable, Job, PersistentObject, HasRevision
```
Stub of the common parts of a Job. You will normally work with a subclass of JobEntity, such as TimerEntity or MessageEntity.

Author:

Tom Baeyens, Nick Burch, Dave Syer, Frederik Heremans

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_EXCLUSIVE`
`static int`	`DEFAULT_RETRIES`
`protected String`	`deploymentId`
`protected Date`	`duedate`
`protected ByteArrayEntity`	`exceptionByteArray`
`protected String`	`exceptionByteArrayId`
`protected String`	`exceptionMessage`
`protected String`	`executionId`
`protected String`	`id`
`protected boolean`	`isExclusive`
`protected String`	`jobHandlerConfiguration`
`protected String`	`jobHandlerType`
`protected Date`	`lockExpirationTime`
`protected String`	`lockOwner`
`protected String`	`processInstanceId`
`protected int`	`retries`
`protected int`	`revision`

Constructor Summary

Constructors
Constructor and Description

JobEntity()

Constructors
Constructor and Description
`JobEntity()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`createFailedJobIncident()`
`void`	`delete()`
`void`	`execute(CommandContext commandContext)`
`String`	`getDeploymentId()` Returns the id of the deployment in which context the job was created.
`Date`	`getDuedate()` Returns the date on which this job is supposed to be processed.
`String`	`getExceptionByteArrayId()`
`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()`
`String`	`getJobHandlerType()`
`Date`	`getLockExpirationTime()`
`String`	`getLockOwner()`
`Object`	`getPersistentState()` Returns a representation of the object, as would be stored in the database.
`String`	`getProcessInstanceId()` Returns the id of the process instance which execution created the job.
`int`	`getRetries()` Returns the number of retries this job has left.
`int`	`getRevision()`
`int`	`getRevisionNext()`
`void`	`insert()`
`boolean`	`isExclusive()`
`protected void`	`removeFailedJobIncident()`
`void`	`setDeploymentId(String deploymentId)`
`void`	`setDuedate(Date duedate)`
`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`	`setLockExpirationTime(Date claimedUntil)`
`void`	`setLockOwner(String claimedBy)`
`void`	`setProcessInstanceId(String processInstanceId)`
`void`	`setRetries(int retries)`
`void`	`setRetriesFromPersistence(int retries)`
`void`	`setRevision(int revision)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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
```
  - lockOwner
```
protected String lockOwner
```
  - lockExpirationTime
```
protected Date lockExpirationTime
```
  - executionId
```
protected String executionId
```
  - processInstanceId
```
protected String processInstanceId
```
  - isExclusive
```
protected boolean isExclusive
```
  - retries
```
protected int retries
```
  - jobHandlerType
```
protected String jobHandlerType
```
  - jobHandlerConfiguration
```
protected String jobHandlerConfiguration
```
  - exceptionByteArray
```
protected ByteArrayEntity exceptionByteArray
```
  - exceptionByteArrayId
```
protected String exceptionByteArrayId
```
  - exceptionMessage
```
protected String exceptionMessage
```
  - deploymentId
```
protected String deploymentId
```
- Constructor Detail
  - JobEntity
```
public JobEntity()
```
- Method Detail
  - execute
```
public void execute(CommandContext commandContext)
```
  - insert
```
public void insert()
```
  - delete
```
public void delete()
```
  - 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
  - setExecution
```
public void setExecution(ExecutionEntity execution)
```
  - 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: Job
    
    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 Job
  - setRetries
```
public void setRetries(int retries)
```
  - setRetriesFromPersistence
```
public void setRetriesFromPersistence(int retries)
```
  - createFailedJobIncident
```
protected void createFailedJobIncident()
```
  - removeFailedJobIncident
```
protected void removeFailedJobIncident()
```
  - getExceptionStacktrace
```
public String getExceptionStacktrace()
```
  - getLockOwner
```
public String getLockOwner()
```
  - setLockOwner
```
public void setLockOwner(String claimedBy)
```
  - getLockExpirationTime
```
public Date getLockExpirationTime()
```
  - setLockExpirationTime
```
public void setLockExpirationTime(Date claimedUntil)
```
  - getProcessInstanceId
```
public String getProcessInstanceId()
```
    Description copied from interface: Job
    
    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()
```
  - setExclusive
```
public void setExclusive(boolean isExclusive)
```
  - getId
```
public String getId()
```
    Description copied from interface: Job
    
    Returns the unique identifier for this job.
    
    Specified by:
    
    getId in interface PersistentObject
    
    Specified by:
    
    getId in interface Job
  - setId
```
public void setId(String id)
```
    Specified by:
    
    setId in interface PersistentObject
  - 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)
```
  - setExceptionStacktrace
```
public void setExceptionStacktrace(String exception)
```
  - getJobHandlerType
```
public String getJobHandlerType()
```
  - setJobHandlerType
```
public void setJobHandlerType(String jobHandlerType)
```
  - getJobHandlerConfiguration
```
public String getJobHandlerConfiguration()
```
  - setJobHandlerConfiguration
```
public void setJobHandlerConfiguration(String jobHandlerConfiguration)
```
  - getRevision
```
public int getRevision()
```
    Specified by:
    
    getRevision in interface HasRevision
  - setRevision
```
public void setRevision(int revision)
```
    Specified by:
    
    setRevision in interface HasRevision
  - getExceptionMessage
```
public String getExceptionMessage()
```
    Description copied from interface: Job
    
    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 Job
  - setExceptionMessage
```
public void setExceptionMessage(String exceptionMessage)
```
  - getExceptionByteArrayId
```
public String getExceptionByteArrayId()
```
  - getDeploymentId
```
public String getDeploymentId()
```
    Description copied from interface: Job
    
    Returns the id of the deployment in which context the job was created.
    
    Specified by:
    
    getDeploymentId in interface Job
  - setDeploymentId
```
public void setDeploymentId(String deploymentId)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class JobEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_EXCLUSIVE

DEFAULT_RETRIES

id

revision

duedate

lockOwner

lockExpirationTime

executionId

processInstanceId

isExclusive

retries

jobHandlerType

jobHandlerConfiguration

exceptionByteArray

exceptionByteArrayId

exceptionMessage

deploymentId

Constructor Detail

JobEntity

Method Detail

execute

insert

delete

getPersistentState

getRevisionNext

setExecution

getExecutionId

setExecutionId

getRetries

setRetries

setRetriesFromPersistence

createFailedJobIncident

removeFailedJobIncident

getExceptionStacktrace

getLockOwner

setLockOwner

getLockExpirationTime

setLockExpirationTime

getProcessInstanceId

setProcessInstanceId

isExclusive

setExclusive

getId

setId

getDuedate

setDuedate

setExceptionStacktrace

getJobHandlerType

setJobHandlerType

getJobHandlerConfiguration

setJobHandlerConfiguration

getRevision

setRevision

getExceptionMessage

setExceptionMessage

getExceptionByteArrayId

getDeploymentId

setDeploymentId

toString