de.bsvrz.ars.ars.mgmt
Interface LongTermTaskStatePublisher.Task

All Known Implementing Classes:
ArchiveLongTermTaskStatePublisher.ArchiveLongTermTask
Enclosing interface:
LongTermTaskStatePublisher

public static interface LongTermTaskStatePublisher.Task

Schnittstelle, die von den einzelnen Tasks verwendet wird, um den Zustand der Task und den Fortschritt von langwierigen Aktionen zu dokumentieren.


Method Summary
 void setTaskProgress(String format, long progress, long maximumProgress, long result)
          Setzt den Fortschritt einer Task.
 void setTaskState(LongTermTaskStatePublisher.TaskState taskState)
          Setzt den Zustand einer Task.
 

Method Detail

setTaskState

void setTaskState(LongTermTaskStatePublisher.TaskState taskState)
Setzt den Zustand einer Task.

Parameters:
taskState - Neuer Zustand der Task.

setTaskProgress

void setTaskProgress(String format,
                     long progress,
                     long maximumProgress,
                     long result)
Setzt den Fortschritt einer Task. Im Falle einer Ausgabe werden der übergebene Formatstring und die weiteren Parameter an die Methode Formatter.format() übergeben um den auszugebenden Text zu ermitteln.

Parameters:
format - Formatstring, der bei Ausgaben dazu verwendet wird, eine textuelle Beschreibung des aktuellen Fortschritts zu erzeugen.
progress - Fortschritt der aktuellen Aktion oder -1, wenn der Fortschritt nicht bekannt ist.
maximumProgress - Maximum des Fortschritts einer Aktion oder -1, wenn das Maximum nicht bekannt ist.
result - Zwischenergebnis der aktuell durchgeführten Aktion oder -1, wenn kein Zwischenergebnis bekannt ist.