Package org.flowable.job.service.impl.persistence.entity

Class AbstractJobEntityImpl

java.lang.Object

org.flowable.common.engine.impl.persistence.entity.AbstractEntity

org.flowable.job.service.impl.persistence.entity.AbstractJobServiceEntity

org.flowable.job.service.impl.persistence.entity.AbstractJobEntityImpl

All Implemented Interfaces:

Serializable, HasRevision, Entity, Job, JobInfo, AbstractJobEntity, AbstractRuntimeJobEntity

Direct Known Subclasses:

DeadLetterJobEntityImpl, ExternalWorkerJobEntityImpl, JobEntityImpl, SuspendedJobEntityImpl, TimerJobEntityImpl

public abstract class AbstractJobEntityImpl
extends AbstractJobServiceEntity
implements AbstractRuntimeJobEntity, Serializable

Abstract job entity class.

Author:

Tijs Rademakers

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	category
protected String	correlationId
protected Date	createTime
protected ByteArrayRef	customValuesByteArrayRef
protected Date	duedate
protected String	elementId
protected String	elementName
protected Date	endDate
protected ByteArrayRef	exceptionByteArrayRef
protected String	exceptionMessage
protected String	executionId
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 String	scopeDefinitionId
protected String	scopeId
protected String	scopeType
protected String	subScopeId
protected String	tenantId

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

id, isDeleted, isInserted, isUpdated, originalPersistentState, revision

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

DEFAULT_EXCLUSIVE, JOB_TYPE_EXTERNAL_WORKER, JOB_TYPE_MESSAGE, JOB_TYPE_TIMER

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

MAX_EXCEPTION_MESSAGE_LENGTH

Constructor Summary

Constructors

Constructor	Description
AbstractJobEntityImpl()

Method Summary

Modifier and Type	Method	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.
ByteArrayRef	getCustomValuesByteArrayRef()
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()
protected String	getEngineType()
ByteArrayRef	getExceptionByteArrayRef()
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	getJobHandlerConfiguration()	Get the job handler configuration.
String	getJobHandlerType()	Get the job handler type.
String	getJobType()	Get the job type for this job.
int	getMaxIterations()
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.
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	setCorrelationId(String correlationId)
void	setCreateTime(Date createTime)
void	setCustomValues(String customValues)
void	setCustomValuesByteArrayRef(ByteArrayRef customValuesByteArrayRef)
void	setDuedate(Date duedate)
void	setElementId(String elementId)
void	setElementName(String elementName)
void	setEndDate(Date endDate)
void	setExceptionByteArrayRef(ByteArrayRef exceptionByteArrayRef)
void	setExceptionMessage(String exceptionMessage)
void	setExceptionStacktrace(String exception)
void	setExclusive(boolean isExclusive)
void	setExecutionId(String executionId)
void	setJobHandlerConfiguration(String jobHandlerConfiguration)
void	setJobHandlerType(String jobHandlerType)
void	setJobType(String jobType)
void	setMaxIterations(int maxIterations)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessInstanceId(String processInstanceId)
void	setRepeat(String repeat)
void	setRetries(int retries)
void	setScopeDefinitionId(String scopeDefinitionId)
void	setScopeId(String scopeId)
void	setScopeType(String scopeType)	Set the scope type for the job.
void	setSubScopeId(String subScopeId)
void	setTenantId(String tenantId)
String	toString()

Methods inherited from class org.flowable.job.service.impl.persistence.entity.AbstractJobServiceEntity

getIdPrefix

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

getId, getIdPrefix, getOriginalPersistentState, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setUpdated

Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision

getRevision, getRevisionNext, setRevision

Methods inherited from interface org.flowable.job.api.JobInfo

getId

Field Details

createTime

protected Date createTime

duedate

protected Date duedate

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

correlationId

protected String correlationId

isExclusive

protected boolean isExclusive

retries

protected int retries

maxIterations

protected int maxIterations

repeat

protected String repeat

endDate

protected Date endDate

jobHandlerType

protected String jobHandlerType

jobHandlerConfiguration

protected String jobHandlerConfiguration

customValuesByteArrayRef

protected ByteArrayRef customValuesByteArrayRef

exceptionByteArrayRef

protected ByteArrayRef exceptionByteArrayRef

exceptionMessage

protected String exceptionMessage

tenantId

protected String tenantId

Constructor Details

AbstractJobEntityImpl

public AbstractJobEntityImpl()

Method Details

getPersistentState

public Object getPersistentState()

Description copied from interface: Entity

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 Entity

getCreateTime

public Date getCreateTime()

Description copied from interface: Job

Returns the create datetime of the job.

Specified by:

getCreateTime in interface AbstractJobEntity

Specified by:

getCreateTime in interface Job

setCreateTime

public void setCreateTime(Date createTime)

Specified by:

setCreateTime in interface AbstractJobEntity

Specified by:

setCreateTime in interface AbstractRuntimeJobEntity

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)

Specified by:

setDuedate in interface AbstractRuntimeJobEntity

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)

Specified by:

setExecutionId in interface AbstractRuntimeJobEntity

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 AbstractJobEntity

Specified by:

getRetries in interface JobInfo

setRetries

public void setRetries(int retries)

Specified by:

setRetries in interface AbstractJobEntity

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)

Specified by:

setProcessInstanceId in interface AbstractRuntimeJobEntity

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)

Specified by:

setExclusive in interface AbstractRuntimeJobEntity

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)

Specified by:

setProcessDefinitionId in interface AbstractRuntimeJobEntity

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)

Specified by:

setElementId in interface AbstractRuntimeJobEntity

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)

Specified by:

setElementName in interface AbstractRuntimeJobEntity

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)

Specified by:

setScopeId in interface AbstractRuntimeJobEntity

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)

Specified by:

setSubScopeId in interface AbstractRuntimeJobEntity

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 AbstractJobEntity

Specified by:

getScopeType in interface Job

setScopeType

public void setScopeType(String scopeType)

Description copied from interface: AbstractJobEntity

Set the scope type for the job. The scope type is the type which is used by the job executor to pick the jobs for executing.

For example if the job should be picked up by the CMMN Job executor then it should have the same type as the CMMN job executor.

Specified by:

setScopeType in interface AbstractJobEntity

Parameters:

scopeType - the scope type for the job

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)

Specified by:

setScopeDefinitionId in interface AbstractRuntimeJobEntity

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

setCorrelationId

public void setCorrelationId(String correlationId)

Specified by:

setCorrelationId in interface AbstractRuntimeJobEntity

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)

Specified by:

setCategory in interface AbstractRuntimeJobEntity

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)

Specified by:

setJobType in interface AbstractRuntimeJobEntity

getRepeat

public String getRepeat()

Specified by:

getRepeat in interface AbstractRuntimeJobEntity

setRepeat

public void setRepeat(String repeat)

Specified by:

setRepeat in interface AbstractRuntimeJobEntity

getEndDate

public Date getEndDate()

Specified by:

getEndDate in interface AbstractRuntimeJobEntity

setEndDate

public void setEndDate(Date endDate)

Specified by:

setEndDate in interface AbstractRuntimeJobEntity

getMaxIterations

public int getMaxIterations()

Specified by:

getMaxIterations in interface AbstractRuntimeJobEntity

setMaxIterations

public void setMaxIterations(int maxIterations)

Specified by:

setMaxIterations in interface AbstractRuntimeJobEntity

getJobHandlerType

public String getJobHandlerType()

Description copied from interface: JobInfo

Get the job handler type.

Specified by:

getJobHandlerType in interface AbstractJobEntity

Specified by:

getJobHandlerType in interface JobInfo

setJobHandlerType

public void setJobHandlerType(String jobHandlerType)

Specified by:

setJobHandlerType in interface AbstractJobEntity

getJobHandlerConfiguration

public String getJobHandlerConfiguration()

Description copied from interface: JobInfo

Get the job handler configuration.

Specified by:

getJobHandlerConfiguration in interface AbstractJobEntity

Specified by:

getJobHandlerConfiguration in interface JobInfo

setJobHandlerConfiguration

public void setJobHandlerConfiguration(String jobHandlerConfiguration)

Specified by:

setJobHandlerConfiguration in interface AbstractJobEntity

getCustomValuesByteArrayRef

public ByteArrayRef getCustomValuesByteArrayRef()

Specified by:

getCustomValuesByteArrayRef in interface AbstractJobEntity

setCustomValuesByteArrayRef

public void setCustomValuesByteArrayRef(ByteArrayRef customValuesByteArrayRef)

Specified by:

setCustomValuesByteArrayRef in interface AbstractJobEntity

getCustomValues

public String getCustomValues()

Description copied from interface: JobInfo

Get the custom values.

Specified by:

getCustomValues in interface AbstractJobEntity

Specified by:

getCustomValues in interface JobInfo

setCustomValues

public void setCustomValues(String customValues)

Specified by:

setCustomValues in interface AbstractJobEntity

getTenantId

public String getTenantId()

Description copied from interface: JobInfo

Get the tenant identifier for this job.

Specified by:

getTenantId in interface AbstractJobEntity

Specified by:

getTenantId in interface JobInfo

setTenantId

public void setTenantId(String tenantId)

Specified by:

setTenantId in interface AbstractJobEntity

getExceptionStacktrace

public String getExceptionStacktrace()

Specified by:

getExceptionStacktrace in interface AbstractJobEntity

setExceptionStacktrace

public void setExceptionStacktrace(String exception)

Specified by:

setExceptionStacktrace in interface AbstractJobEntity

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 AbstractJobEntity

Specified by:

getExceptionMessage in interface JobInfo

setExceptionMessage

public void setExceptionMessage(String exceptionMessage)

Specified by:

setExceptionMessage in interface AbstractJobEntity

getExceptionByteArrayRef

public ByteArrayRef getExceptionByteArrayRef()

Specified by:

getExceptionByteArrayRef in interface AbstractJobEntity

setExceptionByteArrayRef

public void setExceptionByteArrayRef(ByteArrayRef exceptionByteArrayRef)

Specified by:

setExceptionByteArrayRef in interface AbstractJobEntity

getEngineType

protected String getEngineType()

toString

public String toString()

Overrides:

toString in class Object