org.camunda.bpm.engine.batch.history

Interface HistoricBatch

All Known Implementing Classes:

HistoricBatchEntity

public interface HistoricBatch

Historic representation of a Batch.

Method Summary

Modifier and Type	Method and Description
String	getBatchJobDefinitionId()
int	getBatchJobsPerSeed()
String	getCreateUserId()
Date	getEndTime()
String	getId()
int	getInvocationsPerBatchJob()
String	getMonitorJobDefinitionId()
Date	getRemovalTime() The time the historic batch will be removed.
String	getSeedJobDefinitionId()
Date	getStartTime()
String	getTenantId()
int	getTotalJobs()
String	getType()

Method Detail

getId

String getId()

Returns:

the id of the batch

getType

String getType()

Returns:

the type of the batch

getTotalJobs

int getTotalJobs()

Returns:

the number of batch execution jobs required to complete the batch

getBatchJobsPerSeed

int getBatchJobsPerSeed()

Returns:

number of batch jobs created per batch seed job invocation

getInvocationsPerBatchJob

int getInvocationsPerBatchJob()

Returns:

the number of invocations executed per batch job

getSeedJobDefinitionId

String getSeedJobDefinitionId()

Returns:

the id of the batch seed job definition

getMonitorJobDefinitionId

String getMonitorJobDefinitionId()

Returns:

the id of the batch monitor job definition

getBatchJobDefinitionId

String getBatchJobDefinitionId()

Returns:

the id of the batch job definition

getTenantId

String getTenantId()

Returns:

the batch's tenant id or null

getCreateUserId

String getCreateUserId()

Returns:

the batch creator's user id

getStartTime

Date getStartTime()

Returns:

the date the batch was started

getEndTime

Date getEndTime()

Returns:

the date the batch was completed

getRemovalTime

Date getRemovalTime()

The time the historic batch will be removed.