Package de.bsvrz.ars.ars.mgmt.tasks.base
Schnittstelle Task
- Alle Superschnittstellen:
TaskProgressInterface
Schnittstelle, die von den einzelnen Tasks verwendet wird, um den Zustand der Task und den Fortschritt von langwierigen Aktionen zu dokumentieren.
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibunglong
Gibt den Maximalwert vongetProgress()
zurück, also z.getName()
Gibt den Namen des Tasks zurücklong
Gibt den Fortschritt zurück (Z.long
Gibt Optional eine Ergebnisanzahl zurück, z.Gibt einen Text zurück, der den Fortschritt darstellt.getState()
Gibt den Zustand des Tasks zurückvoid
setTaskState
(TaskState taskState) Setzt den Zustand eines Tasks.Von Schnittstelle geerbte Methoden de.bsvrz.ars.ars.mgmt.tasks.base.TaskProgressInterface
setTaskProgress
-
Methodendetails
-
setTaskState
Setzt den Zustand eines Tasks.- Parameter:
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."
- Gibt zurück:
- beliebiger Text
-
getName
String getName()Gibt den Namen des Tasks zurück- Gibt zurück:
- Name (Freitext)
-
getState
TaskState getState()Gibt den Zustand des Tasks zurück- Gibt zurück:
- Zustand
-
getProgress
long getProgress()Gibt den Fortschritt zurück (Z. B. Anzahl bisher bearbeitete Objekte als Anteil vongetMaximumProgress()
).Ist der Fortschritt unbekannt, kann -1 zurückgegeben werden.
- Gibt zurück:
- Fortschritt
-
getMaximumProgress
long getMaximumProgress()Gibt den Maximalwert vongetProgress()
zurück, also z. B. die Gesamtzahl der zu bearbeitenden Objekte.Ist keine Gesamtzahl bekannt, kann -1 zurückgegeben werden.
- Gibt zurück:
- 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 vongetProgress()
bzw.getMaximumProgress()
.Falls nicht benötigt, kann -1 zurückgegeben werden.
- Gibt zurück:
- Ergebnis-Anzahl
-