Interface Task

All Superinterfaces:
TaskProgressInterface

public interface Task extends TaskProgressInterface
Schnittstelle, die von den einzelnen Tasks verwendet wird, um den Zustand der Task und den Fortschritt von langwierigen Aktionen zu dokumentieren.
  • Method Details

    • setTaskState

      void setTaskState(TaskState taskState)
      Setzt den Zustand eines Tasks.
      Parameters:
      taskState - Neuer Zustand.
    • getProgressText

      String getProgressText()
      Gibt einen Text zurück, der den Fortschritt darstellt. Zum Beispiel: "Datenanalyse läuft. 10 von 100 Containern besucht."
      Returns:
      beliebiger Text
    • getName

      String getName()
      Gibt den Namen des Tasks zurück
      Returns:
      Name (Freitext)
    • getState

      TaskState getState()
      Gibt den Zustand des Tasks zurück
      Returns:
      Zustand
    • getProgress

      long getProgress()
      Gibt den Fortschritt zurück (Z. B. Anzahl bisher bearbeitete Objekte als Anteil von getMaximumProgress()).

      Ist der Fortschritt unbekannt, kann -1 zurückgegeben werden.

      Returns:
      Fortschritt
    • getMaximumProgress

      long getMaximumProgress()
      Gibt den Maximalwert von getProgress() zurück, also z. B. die Gesamtzahl der zu bearbeitenden Objekte.

      Ist keine Gesamtzahl bekannt, kann -1 zurückgegeben werden.

      Returns:
      Maximaler Fortschritt
    • getProgressResult

      long getProgressResult()
      Gibt Optional eine Ergebnisanzahl zurück, z. B. die Anzahl der besuchten Container in einem Durchlauf. Diese Zahl ist unabhängig von getProgress() bzw. getMaximumProgress().

      Falls nicht benötigt, kann -1 zurückgegeben werden.

      Returns:
      Ergebnis-Anzahl