org.activiti.engine.impl.persistence.entity

Class AbstractJobEntityImpl

java.lang.Object

org.activiti.engine.impl.persistence.entity.AbstractEntity

org.activiti.engine.impl.persistence.entity.AbstractJobEntityImpl

All Implemented Interfaces:

Serializable, BulkDeleteable, HasRevision, AbstractJobEntity, Entity, Job

Direct Known Subclasses:

DeadLetterJobEntityImpl, JobEntityImpl, SuspendedJobEntityImpl, TimerJobEntityImpl

public abstract class AbstractJobEntityImpl
extends AbstractEntity
implements AbstractJobEntity, BulkDeleteable, Serializable

Abstract job entity class.

Author:

Tijs Rademakers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	duedate
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	tenantId

Fields inherited from class org.activiti.engine.impl.persistence.entity.AbstractEntity

id, isDeleted, isInserted, isUpdated, revision

Fields inherited from interface org.activiti.engine.runtime.Job

DEFAULT_EXCLUSIVE, JOB_TYPE_MESSAGE, JOB_TYPE_TIMER, MAX_EXCEPTION_MESSAGE_LENGTH

Constructor Summary

Constructors

Constructor and Description
AbstractJobEntityImpl()

Method Summary

Modifier and Type	Method and Description
Date	getDuedate() Returns the date on which this job is supposed to be processed.
Date	getEndDate()
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 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() 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	getTenantId() Get the tenant identifier for this job.
protected byte[]	getUtf8Bytes(String str)
boolean	isExclusive() Is the job exclusive?
void	setDuedate(Date duedate)
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	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	setTenantId(String tenantId)
String	toString()

Methods inherited from class org.activiti.engine.impl.persistence.entity.AbstractEntity

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.activiti.engine.runtime.Job

getId

Methods inherited from interface org.activiti.engine.impl.persistence.entity.Entity

getId, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setUpdated

Methods inherited from interface org.activiti.engine.impl.db.HasRevision

getRevision, getRevisionNext, setRevision

Field Detail

duedate

protected Date duedate

executionId

protected String executionId

processInstanceId

protected String processInstanceId

processDefinitionId

protected String processDefinitionId

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

exceptionByteArrayRef

protected ByteArrayRef exceptionByteArrayRef

exceptionMessage

protected String exceptionMessage

tenantId

protected String tenantId

jobType

protected String jobType

Constructor Detail

AbstractJobEntityImpl

public AbstractJobEntityImpl()

Method Detail

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

setExecution

public void setExecution(ExecutionEntity execution)

Specified by:

setExecution in interface AbstractJobEntity

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 AbstractJobEntity

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 AbstractJobEntity

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)

Specified by:

setRetries in interface AbstractJobEntity

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)

Specified by:

setProcessInstanceId in interface AbstractJobEntity

isExclusive

public boolean isExclusive()

Description copied from interface: Job

Is the job exclusive?

Specified by:

isExclusive in interface AbstractJobEntity

Specified by:

isExclusive in interface Job

setExclusive

public void setExclusive(boolean isExclusive)

Specified by:

setExclusive in interface AbstractJobEntity

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 AbstractJobEntity

getRepeat

public String getRepeat()

Specified by:

getRepeat in interface AbstractJobEntity

setRepeat

public void setRepeat(String repeat)

Specified by:

setRepeat in interface AbstractJobEntity

getEndDate

public Date getEndDate()

Specified by:

getEndDate in interface AbstractJobEntity

setEndDate

public void setEndDate(Date endDate)

Specified by:

setEndDate in interface AbstractJobEntity

getMaxIterations

public int getMaxIterations()

Specified by:

getMaxIterations in interface AbstractJobEntity

setMaxIterations

public void setMaxIterations(int maxIterations)

Specified by:

setMaxIterations in interface AbstractJobEntity

getJobHandlerType

public String getJobHandlerType()

Description copied from interface: Job

Get the job handler type.

Specified by:

getJobHandlerType in interface AbstractJobEntity

Specified by:

getJobHandlerType in interface Job

setJobHandlerType

public void setJobHandlerType(String jobHandlerType)

Specified by:

setJobHandlerType in interface AbstractJobEntity

getJobHandlerConfiguration

public String getJobHandlerConfiguration()

Description copied from interface: Job

Get the job configuration.

Specified by:

getJobHandlerConfiguration in interface AbstractJobEntity

Specified by:

getJobHandlerConfiguration in interface Job

setJobHandlerConfiguration

public void setJobHandlerConfiguration(String jobHandlerConfiguration)

Specified by:

setJobHandlerConfiguration in interface AbstractJobEntity

getJobType

public String getJobType()

Description copied from interface: Job

Get the job type for this job.

Specified by:

getJobType in interface AbstractJobEntity

Specified by:

getJobType in interface Job

setJobType

public void setJobType(String jobType)

Specified by:

setJobType in interface AbstractJobEntity

getTenantId

public String getTenantId()

Description copied from interface: Job

Get the tenant identifier for this job.

Specified by:

getTenantId in interface Job

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

Specified by:

setExceptionMessage in interface AbstractJobEntity

getExceptionByteArrayRef

public ByteArrayRef getExceptionByteArrayRef()

Specified by:

getExceptionByteArrayRef in interface AbstractJobEntity

getUtf8Bytes

protected byte[] getUtf8Bytes(String str)

toString

public String toString()

Overrides:

toString in class Object