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

Interface HistoricBatch

  • All Known Implementing Classes:
    HistoricBatchEntity
    public interface HistoricBatch
    Historic representation of a Batch.

    • Method Detail

      • getId

        java.lang.String getId()
        Returns:
        the id of the batch

      • getType

        java.lang.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

        java.lang.String getSeedJobDefinitionId()
        Returns:
        the id of the batch seed job definition

      • getMonitorJobDefinitionId

        java.lang.String getMonitorJobDefinitionId()
        Returns:
        the id of the batch monitor job definition

      • getBatchJobDefinitionId

        java.lang.String getBatchJobDefinitionId()
        Returns:
        the id of the batch job definition

      • getTenantId

        java.lang.String getTenantId()
        Returns:
        the batch's tenant id or null

      • getCreateUserId

        java.lang.String getCreateUserId()
        Returns:
        the batch creator's user id

      • getStartTime

        java.util.Date getStartTime()
        Returns:
        the date the batch was started

      • getEndTime

        java.util.Date getEndTime()
        Returns:
        the date the batch was completed

      • getRemovalTime

        java.util.Date getRemovalTime()
        The time the historic batch will be removed.

      • getExecutionStartTime

        java.util.Date getExecutionStartTime()
        Returns:
        the date the batch execution started