Package org.flowable.external.client

Interface ExternalWorkerJob

All Known Subinterfaces:
AcquiredExternalWorkerJob
All Known Implementing Classes:
BaseAcquiredExternalWorkerJob, BaseExternalWorkerJob
public interface ExternalWorkerJob
Author:
Filip Hrisafov

  • Method Details

    • getId

      String getId()
      Returns the unique identifier for this job.

    • getCorrelationId

      String getCorrelationId()
      Returns the correlation id of a job. The same job can be moved around and have its technical id changed. This id allows tracking that job.

    • getRetries

      int getRetries()
      Returns the number of retries this job has left. Whenever the jobexecutor fails to execute the job, this value is decremented. When it hits zero, the job is supposed to be dead and not retried again (ie a manual retry is required then).

    • getDueDate

      Instant getDueDate()
      Returns the date on which this job is supposed to be processed.

    • getExceptionMessage

      String getExceptionMessage()
      Returns the message of the exception that occurred, the last time the job was executed. Returns null when no exception occurred.

      To get the full exception stacktrace, use ManagementService#getJobExceptionStacktrace(String)

    • getTenantId

      String getTenantId()
      Get the tenant identifier for this job.

    • getElementId

      String getElementId()
      Reference to an element identifier or null if none is set.

    • getElementName

      String getElementName()
      Reference to an element name or null if none is set.

    • getScopeId

      String getScopeId()
      Reference to a scope identifier or null if none is set.

    • getSubScopeId

      String getSubScopeId()
      Reference to a sub scope identifier or null if none is set.

    • getScopeType

      String getScopeType()
      Reference to a scope type or null if none is set.

    • getScopeDefinitionId

      String getScopeDefinitionId()
      Reference to a scope definition identifier or null if none is set.

    • getCreateTime

      Instant getCreateTime()
      Returns the creation datetime of the job.

    • getWorkerId

      String getWorkerId()
      The id of the worker that has the lock on the job

    • getLockExpirationTime

      Instant getLockExpirationTime()
      The time when the lock expires