Module io.automatiko.engine.api
Package io.automatiko.engine.api.jobs

Interface JobsService

public interface JobsService
JobsService provides an entry point for working with different types of jobs that are meant by default to run in background.

  • Method Details

    • scheduleProcessJob

      String scheduleProcessJob(ProcessJobDescription description)
      Schedules process job that is responsible for starting new process instances based on the given description.
      Parameters:
      description - defines what kind of process should be started upon expiration time
      Returns:
      returns unique id of the job

    • scheduleProcessInstanceJob

      String scheduleProcessInstanceJob(ProcessInstanceJobDescription description)
      Schedules process instance related job that will signal exact same process instance upon expiration time.
      Parameters:
      description - defines the context of the process instance that should be signaled
      Returns:
      returns unique id of the job

    • cancelJob

      boolean cancelJob(String id)
      Cancels given job
      Parameters:
      id - unique id of the job
      Returns:
      returns true if the cancellation was successful, otherwise false

    • getScheduledTime

      ZonedDateTime getScheduledTime(String id)
      Returns actual schedule time for the next expiration of given job
      Parameters:
      id - unique id of the job
      Returns:
      returns actual expiration time for the job