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

Class BatchEntity

java.lang.Object
org.camunda.bpm.engine.impl.batch.BatchEntity
All Implemented Interfaces:
Batch, DbEntity, HasDbReferences, HasDbRevision, Nameable
Direct Known Subclasses:
BatchStatisticsEntity
public class BatchEntity extends Object implements Batch, DbEntity, HasDbReferences, Nameable, HasDbRevision

  • Field Details

    • BATCH_SEED_JOB_DECLARATION

      public static final BatchSeedJobDeclaration BATCH_SEED_JOB_DECLARATION

    • BATCH_MONITOR_JOB_DECLARATION

      public static final BatchMonitorJobDeclaration BATCH_MONITOR_JOB_DECLARATION

    • id

      protected String id

    • type

      protected String type

    • totalJobs

      protected int totalJobs

    • jobsCreated

      protected int jobsCreated

    • batchJobsPerSeed

      protected int batchJobsPerSeed

    • invocationsPerBatchJob

      protected int invocationsPerBatchJob

    • seedJobDefinitionId

      protected String seedJobDefinitionId

    • monitorJobDefinitionId

      protected String monitorJobDefinitionId

    • batchJobDefinitionId

      protected String batchJobDefinitionId

    • configuration

      protected ByteArrayField configuration

    • tenantId

      protected String tenantId

    • createUserId

      protected String createUserId

    • suspensionState

      protected int suspensionState

    • startTime

      protected Date startTime

    • executionStartTime

      protected Date executionStartTime

    • revision

      protected int revision

    • seedJobDefinition

      protected JobDefinitionEntity seedJobDefinition

    • monitorJobDefinition

      protected JobDefinitionEntity monitorJobDefinition

    • batchJobDefinition

      protected JobDefinitionEntity batchJobDefinition

    • batchJobHandler

      protected BatchJobHandler<?> batchJobHandler

  • Constructor Details

    • BatchEntity

      public BatchEntity()

  • Method Details

    • getId

      public String getId()
      Specified by:
      getId in interface Batch
      Specified by:
      getId in interface DbEntity
      Returns:
      the id of the batch

    • setId

      public void setId(String id)
      Specified by:
      setId in interface DbEntity

    • getName

      public String getName()
      Specified by:
      getName in interface Nameable

    • getType

      public String getType()
      Specified by:
      getType in interface Batch
      Returns:
      the type of the batch

    • setType

      public void setType(String type)

    • getTotalJobs

      public int getTotalJobs()
      Specified by:
      getTotalJobs in interface Batch
      Returns:
      the number of batch execution jobs required to complete the batch

    • setTotalJobs

      public void setTotalJobs(int totalJobs)

    • getJobsCreated

      public int getJobsCreated()
      Specified by:
      getJobsCreated in interface Batch
      Returns:
      the number of batch execution jobs already created by the seed job

    • setJobsCreated

      public void setJobsCreated(int jobsCreated)

    • getBatchJobsPerSeed

      public int getBatchJobsPerSeed()
      Specified by:
      getBatchJobsPerSeed in interface Batch
      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 Batch
      Returns:
      the number of invocations executed per batch job

    • setInvocationsPerBatchJob

      public void setInvocationsPerBatchJob(int invocationsPerBatchJob)

    • getSeedJobDefinitionId

      public String getSeedJobDefinitionId()
      Specified by:
      getSeedJobDefinitionId in interface Batch
      Returns:
      the id of the batch seed job definition

    • setSeedJobDefinitionId

      public void setSeedJobDefinitionId(String seedJobDefinitionId)

    • getMonitorJobDefinitionId

      public String getMonitorJobDefinitionId()
      Specified by:
      getMonitorJobDefinitionId in interface Batch
      Returns:
      the id of the batch monitor job definition

    • setMonitorJobDefinitionId

      public void setMonitorJobDefinitionId(String monitorJobDefinitionId)

    • getBatchJobDefinitionId

      public String getBatchJobDefinitionId()
      Specified by:
      getBatchJobDefinitionId in interface Batch
      Returns:
      the id of the batch job definition

    • setBatchJobDefinitionId

      public void setBatchJobDefinitionId(String batchJobDefinitionId)

    • getTenantId

      public String getTenantId()
      Specified by:
      getTenantId in interface Batch
      Returns:
      the batch's tenant id or null

    • setTenantId

      public void setTenantId(String tenantId)

    • getCreateUserId

      public String getCreateUserId()
      Specified by:
      getCreateUserId in interface Batch
      Returns:
      the batch creator's user id

    • setCreateUserId

      public void setCreateUserId(String createUserId)

    • getConfiguration

      public String getConfiguration()

    • setConfiguration

      public void setConfiguration(String configuration)

    • setSuspensionState

      public void setSuspensionState(int state)

    • getSuspensionState

      public int getSuspensionState()

    • isSuspended

      public boolean isSuspended()
      Description copied from interface: Batch

      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.

      Specified by:
      isSuspended in interface Batch
      Returns:
      true if this batch is currently suspended, false otherwise
      See Also:

    • getStartTime

      public Date getStartTime()
      Specified by:
      getStartTime in interface Batch
      Returns:
      the date the batch was started

    • setStartTime

      public void setStartTime(Date startTime)

    • getExecutionStartTime

      public Date getExecutionStartTime()
      Specified by:
      getExecutionStartTime in interface Batch
      Returns:
      the date the batch execution started

    • setExecutionStartTime

      public void setExecutionStartTime(Date executionStartTime)

    • setRevision

      public void setRevision(int revision)
      Specified by:
      setRevision in interface HasDbRevision

    • getRevision

      public int getRevision()
      Specified by:
      getRevision in interface HasDbRevision

    • getRevisionNext

      public int getRevisionNext()
      Specified by:
      getRevisionNext in interface HasDbRevision

    • getSeedJobDefinition

      public JobDefinitionEntity getSeedJobDefinition()

    • getMonitorJobDefinition

      public JobDefinitionEntity getMonitorJobDefinition()

    • getBatchJobDefinition

      public JobDefinitionEntity getBatchJobDefinition()

    • getConfigurationBytes

      public byte[] getConfigurationBytes()

    • setConfigurationBytes

      public void setConfigurationBytes(byte[] configuration)

    • getBatchJobHandler

      public BatchJobHandler<?> getBatchJobHandler()

    • 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

    • createSeedJobDefinition

      public JobDefinitionEntity createSeedJobDefinition(String deploymentId)

    • createMonitorJobDefinition

      public JobDefinitionEntity createMonitorJobDefinition()

    • createBatchJobDefinition

      public JobDefinitionEntity createBatchJobDefinition()

    • createSeedJob

      public JobEntity createSeedJob()

    • deleteSeedJob

      public void deleteSeedJob()

    • createMonitorJob

      public JobEntity createMonitorJob(boolean setDueDate)

    • calculateMonitorJobDueDate

      protected Date calculateMonitorJobDueDate()

    • deleteMonitorJob

      public void deleteMonitorJob()

    • delete

      public void delete(boolean cascadeToHistory, boolean deleteJobs)

    • deleteVariables

      protected void deleteVariables(CommandContext commandContext)

    • fireHistoricStartEvent

      public void fireHistoricStartEvent()

    • fireHistoricEndEvent

      public void fireHistoricEndEvent()

    • fireHistoricUpdateEvent

      public void fireHistoricUpdateEvent()

    • isCompleted

      public boolean isCompleted()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getReferencedEntityIds

      public Set<String> getReferencedEntityIds()
      Description copied from interface: HasDbReferences

      Scope: IN-MEMORY references

      Specified by:
      getReferencedEntityIds in interface HasDbReferences
      Returns:
      the ids of the entities that this entity references. Should only return ids for entities of the same type

    • getReferencedEntitiesIdAndClass

      public Map<String,Class> getReferencedEntitiesIdAndClass()
      Description copied from interface: HasDbReferences

      Scope: IN-MEMORY references

      Specified by:
      getReferencedEntitiesIdAndClass in interface HasDbReferences
      Returns:
      a map of the ids and the entities' classes that this entity references. It's used when trying to determine if there was an Optimistic Locking occurrence on an INSERT or UPDATE of an object of this type.