Package de.espirit.firstspirit.scheduling.agency

Interface JobAgent

public interface JobAgent
Agent providing access to the overall information of the active job.
Since:
5.2.14

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SpecialistType<JobAgent>
    TYPE
    Agent providing access to the overall information of the active job.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    abort()
    Abort this job and all currently running tasks.
    @NotNull FileHandle
    getFolder()
    Provides a handle to the job folder.
    @NotNull String
    getFolderPath()
    Provides the absolute path to the job folder.
    @NotNull Date
    getStartingTime()
    Provides the starting time of the job.
    @Nullable Object
    getVariable(@NotNull String name)
    Gets the variable value stored by the given name.
    void
    setVariable(@NotNull String name, @Nullable Object value)
    Sets the variable of the given name to the defined value.

  • Field Details

    • TYPE

      static final SpecialistType<JobAgent> TYPE
      Agent providing access to the overall information of the active job.
      Since:
      5.2.14

  • Method Details

    • getStartingTime

      @NotNull @NotNull Date getStartingTime()
      Provides the starting time of the job.
      Returns:
      The job's starting time.
      Since:
      5.2.14

    • getVariable

      @Nullable @Nullable Object getVariable(@NotNull @NotNull String name)
      Gets the variable value stored by the given name.
      Parameters:
      name - The variable's name.
      Returns:
      The variable's value.
      Since:
      5.2.14

    • setVariable

      void setVariable(@NotNull @NotNull String name, @Nullable @Nullable Object value)
      Sets the variable of the given name to the defined value. The lifetime of variables spans over the lifetime of this job.
      Parameters:
      name - The variable's name.
      value - The variable's value.
      Since:
      5.2.14

    • getFolder

      @NotNull @NotNull FileHandle getFolder() throws IOException
      Provides a handle to the job folder.
      Returns:
      The job's folder.
      Throws:
      IOException - If the folder could not be found or accessed.
      Since:
      5.2.14

    • getFolderPath

      @NotNull @NotNull String getFolderPath()
      Provides the absolute path to the job folder.
      Returns:
      The absolute path.
      Since:
      5.2.202

    • abort

      void abort()
      Abort this job and all currently running tasks.
      Since:
      5.2.14