Package org.camunda.bpm.engine.runtime

Interface Job

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Date getCreateTime()
      The date/time when this job has been created
      java.lang.String getDeploymentId()
      Returns the id of the deployment in which context the job was created.
      java.util.Date getDuedate()
      Returns the date on which this job is supposed to be processed.
      java.lang.String getExceptionMessage()
      Returns the message of the exception that occurred, the last time the job was executed.
      java.lang.String getExecutionId()
      Returns the specific execution on which the job was created.
      java.lang.String getFailedActivityId()
      Returns the id of the activity on which the last exception occurred.
      java.lang.String getId()
      Returns the unique identifier for this job.
      java.lang.String getJobDefinitionId()
      The id of the JobDefinition for this job.
      long getPriority()
      The job's priority that is a hint to job acquisition.
      java.lang.String getProcessDefinitionId()
      Returns the id of the process definition which created the job.
      java.lang.String getProcessDefinitionKey()
      Returns the key of the process definition which created the job.
      java.lang.String getProcessInstanceId()
      Returns the id of the process instance which execution created the job.
      int getRetries()
      Returns the number of retries this job has left.
      java.lang.String getTenantId()
      The id of the tenant this job belongs to.
      boolean isSuspended()
      Indicates whether this job is suspended.

    • Method Detail

      • getId

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

      • getDuedate

        java.util.Date getDuedate()
        Returns the date on which this job is supposed to be processed.

      • getProcessInstanceId

        java.lang.String getProcessInstanceId()
        Returns the id of the process instance which execution created the job.

      • getProcessDefinitionId

        java.lang.String getProcessDefinitionId()
        Returns the id of the process definition which created the job.

      • getProcessDefinitionKey

        java.lang.String getProcessDefinitionKey()
        Returns the key of the process definition which created the job.

      • getExecutionId

        java.lang.String getExecutionId()
        Returns the specific execution on which the job was created.

      • 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).

      • getExceptionMessage

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

      • getFailedActivityId

        java.lang.String getFailedActivityId()
        Returns the id of the activity on which the last exception occurred.

      • getDeploymentId

        java.lang.String getDeploymentId()
        Returns the id of the deployment in which context the job was created.

      • getJobDefinitionId

        java.lang.String getJobDefinitionId()
        The id of the JobDefinition for this job.

      • isSuspended

        boolean isSuspended()
        Indicates whether this job is suspended. If a job is suspended, the job will be not acquired by the job executor.
        Returns:
        true if this Job is currently suspended.

      • getPriority

        long getPriority()
        The job's priority that is a hint to job acquisition.
        Since:
        7.4

      • getTenantId

        java.lang.String getTenantId()
        The id of the tenant this job belongs to. Can be null if the job belongs to no single tenant.

      • getCreateTime

        java.util.Date getCreateTime()
        The date/time when this job has been created