Package de.espirit.firstspirit.access.schedule

Interface ScheduleEntryControl

public interface ScheduleEntryControl
Provides information on a currently running or a historic schedule entry.
Since:
4.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    awaitTermination()
    Blocks until the schedule entry has terminated.
    @Nullable Date
    getFinishTime()
    Returns the time this schedule entry has been finished or null when the entry has not finished.
    long
    getId()
    Returns the execution id.
    ScheduleEntry
    getScheduleEntry()
    Returns the schedule entry.
    Date
    getStartTime()
    Returns the time this schedule entry has been started.
    ScheduleEntryState
    getState()
    Returns the schedule entry state of this entry control.
    @Nullable User
    getUser()
    Returns the user who initialized execution of the belonging schedule entry, or null if user is unknown (scheduled start for example).
    boolean
    isRunning()
    Returns false, if this schedule entry is finished or not started yet, true otherwise.
    void
    refresh()
    Requests the actual version from the server.
    void
    stopExecution()
    Stops the execution of this schedule entry.

  • Method Details

    • getId

      long getId()
      Returns the execution id.
      Returns:
      The execution id.
      Since:
      4.0

    • getUser

      @Nullable @Nullable User getUser()
      Returns the user who initialized execution of the belonging schedule entry, or null if user is unknown (scheduled start for example).
      Since:
      4.0.120

    • getStartTime

      Date getStartTime()
      Returns the time this schedule entry has been started.
      Returns:
      The time this schedule entry has been started.
      Since:
      4.0

    • getFinishTime

      @Nullable @Nullable Date getFinishTime()
      Returns the time this schedule entry has been finished or null when the entry has not finished.
      Returns:
      The time this schedule entry has been finished or null when the entry has not finished.
      Since:
      4.0

    • getScheduleEntry

      ScheduleEntry getScheduleEntry()
      Returns the schedule entry.
      Returns:
      The schedule entry.
      Since:
      4.0

    • isRunning

      boolean isRunning()
      Returns false, if this schedule entry is finished or not started yet, true otherwise.
      Returns:
      false, if this schedule entry is finished or not started yet, true otherwise.
      Since:
      4.0
      See Also:

    • stopExecution

      void stopExecution()
      Stops the execution of this schedule entry.
      Since:
      4.0
      See Also:

    • awaitTermination

      void awaitTermination()
      Blocks until the schedule entry has terminated.
      Since:
      4.0
      See Also:

    • getState

      ScheduleEntryState getState()
      Returns the schedule entry state of this entry control.
      Returns:
      The schedule entry state of this entry control.
      Since:
      4.0

    • refresh

      void refresh()
      Requests the actual version from the server.
      Since:
      4.0
      See Also: