Package org.flowable.external.client.impl

Class BaseExternalWorkerJob

java.lang.Object
org.flowable.external.client.impl.BaseExternalWorkerJob
All Implemented Interfaces:
ExternalWorkerJob
Direct Known Subclasses:
BaseAcquiredExternalWorkerJob
public class BaseExternalWorkerJob extends Object implements ExternalWorkerJob
Author:
Filip Hrisafov

  • Field Details

    • id

      protected String id

    • correlationId

      protected String correlationId

    • retries

      protected int retries

    • scopeId

      protected String scopeId

    • scopeType

      protected String scopeType

    • subScopeId

      protected String subScopeId

    • scopeDefinitionId

      protected String scopeDefinitionId

    • tenantId

      protected String tenantId

    • elementId

      protected String elementId

    • elementName

      protected String elementName

    • exceptionMessage

      protected String exceptionMessage

    • dueDate

      protected Instant dueDate

    • createTime

      protected Instant createTime

    • workerId

      protected String workerId

    • lockExpirationTime

      protected Instant lockExpirationTime

  • Constructor Details

    • BaseExternalWorkerJob

      public BaseExternalWorkerJob()

  • Method Details

    • getId

      public String getId()
      Description copied from interface: ExternalWorkerJob
      Returns the unique identifier for this job.
      Specified by:
      getId in interface ExternalWorkerJob

    • setId

      public void setId(String id)

    • getCorrelationId

      public String getCorrelationId()
      Description copied from interface: ExternalWorkerJob
      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.
      Specified by:
      getCorrelationId in interface ExternalWorkerJob

    • setCorrelationId

      public void setCorrelationId(String correlationId)

    • getRetries

      public int getRetries()
      Description copied from interface: ExternalWorkerJob
      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).
      Specified by:
      getRetries in interface ExternalWorkerJob

    • setRetries

      public void setRetries(int retries)

    • getDueDate

      public Instant getDueDate()
      Description copied from interface: ExternalWorkerJob
      Returns the date on which this job is supposed to be processed.
      Specified by:
      getDueDate in interface ExternalWorkerJob

    • setDueDate

      public void setDueDate(Instant dueDate)

    • getExceptionMessage

      public String getExceptionMessage()
      Description copied from interface: ExternalWorkerJob
      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)

      Specified by:
      getExceptionMessage in interface ExternalWorkerJob

    • setExceptionMessage

      public void setExceptionMessage(String exceptionMessage)

    • getTenantId

      public String getTenantId()
      Description copied from interface: ExternalWorkerJob
      Get the tenant identifier for this job.
      Specified by:
      getTenantId in interface ExternalWorkerJob

    • setTenantId

      public void setTenantId(String tenantId)

    • getElementId

      public String getElementId()
      Description copied from interface: ExternalWorkerJob
      Reference to an element identifier or null if none is set.
      Specified by:
      getElementId in interface ExternalWorkerJob

    • setElementId

      public void setElementId(String elementId)

    • getElementName

      public String getElementName()
      Description copied from interface: ExternalWorkerJob
      Reference to an element name or null if none is set.
      Specified by:
      getElementName in interface ExternalWorkerJob

    • setElementName

      public void setElementName(String elementName)

    • getScopeId

      public String getScopeId()
      Description copied from interface: ExternalWorkerJob
      Reference to a scope identifier or null if none is set.
      Specified by:
      getScopeId in interface ExternalWorkerJob

    • setScopeId

      public void setScopeId(String scopeId)

    • getSubScopeId

      public String getSubScopeId()
      Description copied from interface: ExternalWorkerJob
      Reference to a sub scope identifier or null if none is set.
      Specified by:
      getSubScopeId in interface ExternalWorkerJob

    • setSubScopeId

      public void setSubScopeId(String subScopeId)

    • getScopeType

      public String getScopeType()
      Description copied from interface: ExternalWorkerJob
      Reference to a scope type or null if none is set.
      Specified by:
      getScopeType in interface ExternalWorkerJob

    • setScopeType

      public void setScopeType(String scopeType)

    • getScopeDefinitionId

      public String getScopeDefinitionId()
      Description copied from interface: ExternalWorkerJob
      Reference to a scope definition identifier or null if none is set.
      Specified by:
      getScopeDefinitionId in interface ExternalWorkerJob

    • setScopeDefinitionId

      public void setScopeDefinitionId(String scopeDefinitionId)

    • getCreateTime

      public Instant getCreateTime()
      Description copied from interface: ExternalWorkerJob
      Returns the creation datetime of the job.
      Specified by:
      getCreateTime in interface ExternalWorkerJob

    • setCreateTime

      public void setCreateTime(Instant createTime)

    • getWorkerId

      public String getWorkerId()
      Description copied from interface: ExternalWorkerJob
      The id of the worker that has the lock on the job
      Specified by:
      getWorkerId in interface ExternalWorkerJob

    • setWorkerId

      public void setWorkerId(String workerId)

    • getLockExpirationTime

      public Instant getLockExpirationTime()
      Description copied from interface: ExternalWorkerJob
      The time when the lock expires
      Specified by:
      getLockExpirationTime in interface ExternalWorkerJob

    • setLockExpirationTime

      public void setLockExpirationTime(Instant lockExpirationTime)