Package org.camunda.bpm.engine.impl.batch.history

Class HistoricBatchEntity

java.lang.Object

org.camunda.bpm.engine.impl.history.event.HistoryEvent

org.camunda.bpm.engine.impl.batch.history.HistoricBatchEntity

All Implemented Interfaces:

Serializable, HistoricBatch, DbEntity, HistoricEntity

public class HistoricBatchEntity
extends HistoryEvent
implements HistoricBatch, DbEntity

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	batchJobDefinitionId
protected int	batchJobsPerSeed
protected String	createUserId
protected Date	endTime
protected Date	executionStartTime
protected String	id
protected int	invocationsPerBatchJob
protected String	monitorJobDefinitionId
protected String	seedJobDefinitionId
protected Date	startTime
protected String	tenantId
protected int	totalJobs
protected String	type

Fields inherited from class org.camunda.bpm.engine.impl.history.event.HistoryEvent

ACTIVITY_EVENT_TYPE_END, ACTIVITY_EVENT_TYPE_START, ACTIVITY_EVENT_TYPE_UPDATE, caseDefinitionId, caseDefinitionKey, caseDefinitionName, caseExecutionId, caseInstanceId, eventType, executionId, FORM_PROPERTY_UPDATE, IDENTITY_LINK_ADD, IDENTITY_LINK_DELETE, INCIDENT_CREATE, INCIDENT_DELETE, INCIDENT_RESOLVE, processDefinitionId, processDefinitionKey, processDefinitionName, processDefinitionVersion, processInstanceId, removalTime, rootProcessInstanceId, sequenceCounter, TASK_EVENT_TYPE_COMPLETE, TASK_EVENT_TYPE_CREATE, TASK_EVENT_TYPE_DELETE, TASK_EVENT_TYPE_UPDATE, VARIABLE_EVENT_TYPE_CREATE, VARIABLE_EVENT_TYPE_DELETE, VARIABLE_EVENT_TYPE_UPDATE

Constructor Summary

Constructors

Constructor	Description
HistoricBatchEntity()

Method Summary

Modifier and Type	Method	Description
void	delete()
String	getBatchJobDefinitionId()
int	getBatchJobsPerSeed()
String	getCreateUserId()
Date	getEndTime()
Date	getExecutionStartTime()
int	getInvocationsPerBatchJob()
String	getMonitorJobDefinitionId()
Object	getPersistentState()	Returns a representation of the object, as would be stored in the database.
String	getSeedJobDefinitionId()
Date	getStartTime()
String	getTenantId()
int	getTotalJobs()
String	getType()
void	setBatchJobDefinitionId(String batchJobDefinitionId)
void	setBatchJobsPerSeed(int batchJobsPerSeed)
void	setCreateUserId(String createUserId)
void	setEndTime(Date endTime)
void	setExecutionStartTime(Date executionStartTime)
void	setInvocationsPerBatchJob(int invocationsPerBatchJob)
void	setMonitorJobDefinitionId(String monitorJobDefinitionId)
void	setSeedJobDefinitionId(String seedJobDefinitionId)
void	setStartTime(Date startTime)
void	setTenantId(String tenantId)
void	setTotalJobs(int totalJobs)
void	setType(String type)

Methods inherited from class org.camunda.bpm.engine.impl.history.event.HistoryEvent

getCaseDefinitionId, getCaseDefinitionKey, getCaseDefinitionName, getCaseExecutionId, getCaseInstanceId, getEventType, getExecutionId, getId, getProcessDefinitionId, getProcessDefinitionKey, getProcessDefinitionName, getProcessDefinitionVersion, getProcessInstanceId, getRemovalTime, getRootProcessInstanceId, getSequenceCounter, isEventOfType, setCaseDefinitionId, setCaseDefinitionKey, setCaseDefinitionName, setCaseExecutionId, setCaseInstanceId, setEventType, setExecutionId, setId, setProcessDefinitionId, setProcessDefinitionKey, setProcessDefinitionName, setProcessDefinitionVersion, setProcessInstanceId, setRemovalTime, setRootProcessInstanceId, setSequenceCounter, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.engine.impl.db.DbEntity

getId, setId

Methods inherited from interface org.camunda.bpm.engine.batch.history.HistoricBatch

getId, getRemovalTime

Field Details

id

protected String id

type

protected String type

totalJobs

protected int totalJobs

batchJobsPerSeed

protected int batchJobsPerSeed

invocationsPerBatchJob

protected int invocationsPerBatchJob

seedJobDefinitionId

protected String seedJobDefinitionId

monitorJobDefinitionId

protected String monitorJobDefinitionId

batchJobDefinitionId

protected String batchJobDefinitionId

tenantId

protected String tenantId

createUserId

protected String createUserId

startTime

protected Date startTime

endTime

protected Date endTime

executionStartTime

protected Date executionStartTime

Constructor Details

HistoricBatchEntity

public HistoricBatchEntity()

Method Details

getType

public String getType()

Specified by:

getType in interface HistoricBatch

Returns:

the type of the batch

setType

public void setType(String type)

getTotalJobs

public int getTotalJobs()

Specified by:

getTotalJobs in interface HistoricBatch

Returns:

the number of batch execution jobs required to complete the batch

setTotalJobs

public void setTotalJobs(int totalJobs)

getBatchJobsPerSeed

public int getBatchJobsPerSeed()

Specified by:

getBatchJobsPerSeed in interface HistoricBatch

Returns:

number of batch jobs created per batch seed job invocation

setBatchJobsPerSeed

public void setBatchJobsPerSeed(int batchJobsPerSeed)

getInvocationsPerBatchJob

public int getInvocationsPerBatchJob()

Specified by:

getInvocationsPerBatchJob in interface HistoricBatch

Returns:

the number of invocations executed per batch job

setInvocationsPerBatchJob

public void setInvocationsPerBatchJob(int invocationsPerBatchJob)

getSeedJobDefinitionId

public String getSeedJobDefinitionId()

Specified by:

getSeedJobDefinitionId in interface HistoricBatch

Returns:

the id of the batch seed job definition

setSeedJobDefinitionId

public void setSeedJobDefinitionId(String seedJobDefinitionId)

getMonitorJobDefinitionId

public String getMonitorJobDefinitionId()

Specified by:

getMonitorJobDefinitionId in interface HistoricBatch

Returns:

the id of the batch monitor job definition

setMonitorJobDefinitionId

public void setMonitorJobDefinitionId(String monitorJobDefinitionId)

getBatchJobDefinitionId

public String getBatchJobDefinitionId()

Specified by:

getBatchJobDefinitionId in interface HistoricBatch

Returns:

the id of the batch job definition

setBatchJobDefinitionId

public void setBatchJobDefinitionId(String batchJobDefinitionId)

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface HistoricBatch

Returns:

the batch's tenant id or null

setTenantId

public void setTenantId(String tenantId)

getCreateUserId

public String getCreateUserId()

Specified by:

getCreateUserId in interface HistoricBatch

Returns:

the batch creator's user id

setCreateUserId

public void setCreateUserId(String createUserId)

getStartTime

public Date getStartTime()

Specified by:

getStartTime in interface HistoricBatch

Returns:

the date the batch was started

setStartTime

public void setStartTime(Date startTime)

getEndTime

public Date getEndTime()

Specified by:

getEndTime in interface HistoricBatch

Returns:

the date the batch was completed

setEndTime

public void setEndTime(Date endTime)

getExecutionStartTime

public Date getExecutionStartTime()

Specified by:

getExecutionStartTime in interface HistoricBatch

Returns:

the date the batch execution started

setExecutionStartTime

public void setExecutionStartTime(Date executionStartTime)

getPersistentState

public Object getPersistentState()

Description copied from interface: DbEntity

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 DbEntity

Overrides:

getPersistentState in class HistoryEvent

delete

public void delete()