Package uk.ac.warwick.dcs.sherlock.api.executor

Interface IJobStatus

  • All Superinterfaces:
    java.lang.Comparable<IJobStatus>
    All Known Implementing Classes:
    JobStatus
    public interface IJobStatus
extends java.lang.Comparable<IJobStatus>
    Interface defining the status information available for a job

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int compareTo​(@NotNull IJobStatus o)
      java.time.Duration getDuration()
      fetches the current duration of the job, if job finished gives the total runtime
      java.lang.String getFormattedDuration()
      Fetches the current duration of the job as a formatted string, if job finished gives the total runtime
      int getId()
      get the id of the jobstatus
      java.lang.String getMessage()
      Returns the current status message for the job
      float getProgress()
      returns the current progress estimate for the job, between 0 and 1
      int getProgressInt()
      returns the current progress estimate for the job, as percentage between 0 and 100
      java.time.Instant getStartTime()
      returns the start time of the job
      int getStep()
      Fetches the current "step" for the job, the stage it is at
      boolean isFinished()
      returns whether the job has finished

    • Method Detail

      • compareTo

        int compareTo​(@NotNull
              @NotNull IJobStatus o)
        Specified by:
        compareTo in interface java.lang.Comparable<IJobStatus>

      • getDuration

        java.time.Duration getDuration()
        fetches the current duration of the job, if job finished gives the total runtime
        Returns:
        duration

      • getFormattedDuration

        java.lang.String getFormattedDuration()
        Fetches the current duration of the job as a formatted string, if job finished gives the total runtime
        Returns:
        duration as string

      • getId

        int getId()
        get the id of the jobstatus
        Returns:
        id

      • getMessage

        java.lang.String getMessage()
        Returns the current status message for the job
        Returns:
        message

      • getProgress

        float getProgress()
        returns the current progress estimate for the job, between 0 and 1
        Returns:
        progress estimate

      • getProgressInt

        int getProgressInt()
        returns the current progress estimate for the job, as percentage between 0 and 100
        Returns:
        progress estimate percentage

      • getStartTime

        java.time.Instant getStartTime()
        returns the start time of the job
        Returns:
        start time

      • getStep

        int getStep()
        Fetches the current "step" for the job, the stage it is at
        Returns:
        stage of job

      • isFinished

        boolean isFinished()
        returns whether the job has finished
        Returns:
        finished