Package de.elo.client.scripting.interfaces

Class BackgroundJob

  • public class BackgroundJob
extends Object

    Überschrift: BackgroundJob

    Beschreibung: Ein Hintergrundprozess des Scripting.

    Copyright: Copyright (c) ELO Digital Office GmbH 2015

    Since:
    9.02.000

    • Constructor Summary

      Constructors 
      Constructor Description
      BackgroundJob​(Workspace workspace, String jobTypeName, String backgroundFunction)
      Interner Konstruktor

    • Method Summary

      Modifier and Type Method Description
      void addProtocolEntry​(CONSTANTS.PROTOCOL_LEVEL level, String message)
      Fügt einen Eintrag in das Protokoll des Hintergrunfprozesses ein.
      void addProtocolEntry​(CONSTANTS.PROTOCOL_LEVEL level, String message, int objId)
      Fügt einen Eintrag in das Protokoll des Hintergrunfprozesses ein.
      boolean isStopped()
      Prüft nach, ob der Vorgang abgebrochen werden soll.
      void setFinished()
      Setzt den Status des Vorgangs auf "Beendet".
      void setStatus​(String detailText)
      Setzt den Status, welcher als "Details" in der Prozessübersicht angezeigt wird.
      void showProtocol()
      Öffnet einen Dialog zur Anzeige des Protokolls.
      void stop()
      Sendet das Signal zum abbrechen des Vorgangs.

      • Methods inherited from class Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BackgroundJob

        public BackgroundJob​(Workspace workspace,
                     String jobTypeName,
                     String backgroundFunction)
        Interner Konstruktor
        Parameters:
        workspace - Aktueller Arbeitsbereich
        jobTypeName - Name des Hintergrundprozesses
        backgroundFunction - Scripting-Funktion, welche im Hintergrund ausgeführt werden soll

    • Method Detail

      • stop

        public void stop()
        Sendet das Signal zum abbrechen des Vorgangs.

      • setFinished

        public void setFinished()
        Setzt den Status des Vorgangs auf "Beendet". Der Eintrag in der Prozessübersicht wird entfernt, wenn kein Protokoll geschrieben wurde. Mit Protokoll bleibt er stehen, bis er manuell entfernt wird oder der Client beendet wird.

      • isStopped

        public boolean isStopped()
        Prüft nach, ob der Vorgang abgebrochen werden soll.
        Returns:
        True wenn der Vorgang abgebrochen werden soll, False sonst.

      • addProtocolEntry

        public void addProtocolEntry​(CONSTANTS.PROTOCOL_LEVEL level,
                             String message)
        Fügt einen Eintrag in das Protokoll des Hintergrunfprozesses ein.
        Parameters:
        level - Stufe mit welcher der Eintrag in das Protokoll geschrieben wird, siehe PROTOCOLL_LEVEL
        message - Nachricht

      • addProtocolEntry

        public void addProtocolEntry​(CONSTANTS.PROTOCOL_LEVEL level,
                             String message,
                             int objId)
        Fügt einen Eintrag in das Protokoll des Hintergrunfprozesses ein.
        Parameters:
        level - Stufe mit welcher der Eintrag in das Protokoll geschrieben wird, siehe PROTOCOL_LEVEL
        message - Nachricht
        objId - Objekt-ID, wenn es einen Bezug zu einem Archiveintrag gibt

      • showProtocol

        public void showProtocol()
        Öffnet einen Dialog zur Anzeige des Protokolls.

      • setStatus

        public void setStatus​(String detailText)
        Setzt den Status, welcher als "Details" in der Prozessübersicht angezeigt wird.
        Parameters:
        detailText - Angezeigter Text