org.camunda.bpm.engine.batch
Interface Batch

All Known Subinterfaces:

BatchStatistics

All Known Implementing Classes:

BatchEntity, BatchStatisticsEntity

public interface Batch

A batch represents a number of jobs which execute a number of commands asynchronously.

Batches have three types of jobs:

• Seed jobs: Create execution jobs
• Execution jobs: Execute the actual action
• Monitor jobs: Manage the batch once all execution jobs have been created (e.g. responsible for deletion of the Batch after completion).

All three job types have independent job definitions. They can be controlled individually (e.g. suspension) and are independently represented in the historic job log.

Field Summary

static String	TYPE_PROCESS_INSTANCE_DELETION
static String	TYPE_PROCESS_INSTANCE_MIGRATION

Method Summary

String	getBatchJobDefinitionId()
int	getBatchJobsPerSeed()
String	getId()
int	getInvocationsPerBatchJob()
int	getJobsCreated()
String	getMonitorJobDefinitionId()
String	getSeedJobDefinitionId()
String	getTenantId()
int	getTotalJobs()
String	getType()
boolean	isSuspended() Indicates whether this batch is suspended.

Field Detail

TYPE_PROCESS_INSTANCE_MIGRATION

static final String TYPE_PROCESS_INSTANCE_MIGRATION

See Also:

Constant Field Values

TYPE_PROCESS_INSTANCE_DELETION

static final String TYPE_PROCESS_INSTANCE_DELETION

See Also:

Constant Field Values

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

getJobsCreated

int getJobsCreated()

Returns:

the number of batch execution jobs already created by the seed job

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

isSuspended

boolean isSuspended()

Indicates whether this batch is suspended. If a batch is suspended, the batch jobs will not be acquired by the job executor.

Note: It is still possible to manually suspend and activate jobs and job definitions using the ManagementService, which will not change the suspension state of the batch.

Returns:

true if this batch is currently suspended, false otherwise

See Also:

ManagementService.suspendBatchById(String), ManagementService.activateBatchById(String)