Package net.solarnetwork.central.scheduler

Interface JobInfo

All Known Implementing Classes:
BasicJobInfo, ScheduledJob
public interface JobInfo
Information about a scheduled job.

Jobs are uniquely defined by a group name plus a job name.

Since:
1.37

  • Method Details

    • getGroupId

      String getGroupId()
      Get the group this job belongs to.
      Returns:
      the group ID

    • getId

      String getId()
      Get the ID of this job, unique to the job's group.
      Returns:
      the job ID

    • getJobStatus

      JobStatus getJobStatus()
      Get the status of this job.
      Returns:
      the job status

    • isExecuting

      boolean isExecuting()
      Flag indicating the job is currently executing.
      Returns:
      true if the job is executing

    • getPreviousExecutionTime

      Instant getPreviousExecutionTime()
      Get the previous execution time of the job.

      If the job is currently executing, this value represents the time the job started.

      Returns:
      the previous execution time, or null if the job has never run before

    • getNextExecutionTime

      Instant getNextExecutionTime()
      Get the next execution time of the job.
      Returns:
      the next execution time, or null if no more executions are scheduled

    • getExecutionScheduleDescription

      String getExecutionScheduleDescription()
      Get a description of the execution schedule of the job.

      The description might be a period like "every 10 minutes" or a cron expression, for example.

      Returns:
      a description of the execution schedule