Class SkriptLauf

  • Direct Known Subclasses:
    ClientSkriptLauf, ServerSkriptLauf, SkriptLaufDaten

    public abstract class SkriptLauf
    extends java.lang.Object
    Allgemeine Repräsentation der Daten eines Skriptlaufs.
    Ein Skriptlauf beischreibt die Ausführungsumgebung für ein zugeordnetes Uda-Skript und die Bedingungen für seine Ausführung.
    • Constructor Summary

      Constructors 
      Constructor Description
      SkriptLauf()  
    • Method Summary

      Modifier and Type Method Description
      void addHistorie​(Historie eintrag)
      fügt dem Skript einen Historie-Eintrag hinzu.
      void addProtokoll​(Protokoll protokoll)
      fügt dem Skriptlauf eine Protokolldefinition hinzu.
      void ausgeben​(ProtokollEintrag daten)
      gibt die übergebenen Daten über alle dem Skriptlauf zugewiesenen Ausgabakanäle aus.
      void clearHistorie()
      löscht die Liste der Historie-Einträge.
      void clearParameter()
      löscht die Liste der Parameter des Skripts.
      void clearProtokolle()
      entfernt alle für den Skriptlauf definierten Protokolleinträge.
      java.lang.String getBenutzer()
      liefert den Name des Benutzers mit dem die Anmeldung beim Datenverteiler bei der Asuführung des Skripts erfolgen soll.
      java.lang.String getBeschreibung()
      liefert die erläuternde Beschreibung des Skriptlaufs.
      java.util.List<Historie> getHistorie()
      liefert die Liste der Einträge der Bearbeitungsgeschichte des Skripts.
      UdaInterpreter getInterpreter()
      liefert den ausführenden Interpreter.
      abstract Modul getModul()
      liefert das Modul, in dem der Skriptlauf definiert ist.
      java.lang.String getName()
      liefert den Namen des Skripts.
      Ist kein Name definiert wird die Zeichenkette UdaKonstante.STRING_UNBEKANNT zurückgeliefert.
      java.util.Map<java.lang.String,​java.lang.String> getParameter()
      liefert die Liste der Parameter, mit denen das dem Skriptlauf zugeordnete Skript ausgeführt werden soll.
      java.lang.String getPasswd()
      liefert des Passwort düe die Anmeldung beim Datenverteiler bei der Ausführung des Skriptlaufs.
      java.util.Collection<Protokoll> getProtokolle()
      liefert die Liste der Protokolle, die bei der Ausführung des Skripts erstellt werden sollen.
      Skript getSkript()
      liefert das dem Skriptlauf zugeordnete Skript.
      java.util.Map<java.lang.String,​java.lang.String> getSkriptParameter()
      liefert die Liste der für das Skript definierten Parameter.
      StartTyp getStartTyp()
      liefert den für das Skript definierten Starttyp.
      SkriptLaufStatus getStatus()
      liefert den aktuellen Status der Ausführung des Skripts.
      StartZyklus getZyklus()
      liefert die Daten für eine zyklische oder zeitgesteuerte Ausführung des Skriptlaufs.
      void initialisiereProtokolle()
      initialisiert alle Protokolle vor der Ausführung des zugeordneten Skripts.
      void kopiereDaten​(SkriptLauf quellLauf)
      die Funktion übernimmt die Daten des übergebenen Skriptlaufs.
      void protokolleAbschliessen()
      schließt alle Protokolle des Skriptlaufs.
      abstract void publiziereErgebnis​(java.lang.Exception fehler)
      veröffentlicht das Ergebnis eines Skriptlaufs.
      void removeParameter​(java.lang.String parameter)
      entfernt den mit dem Namen benannten Parameter des Skripts.
      void removeProtokoll​(Protokoll item)
      entfernt einen Protokolleintrag aus den Definitionen des Skriptlaufs.
      void setBenutzer​(java.lang.String benutzer)
      setzt den Namen des Benutzers, unter dessen Namen das Skript ausgeführt werden soll.
      void setBeschreibung​(java.lang.String beschreibung)
      setzt den erläuternden Text des Skriptlaufs.
      void setInterpreter​(UdaInterpreter interpreter)
      setzt den Interpreter, der den Skriptlauf ausführt.
      void setName​(java.lang.String name)
      setzt den Namen des Skriptlaufs.
      void setParameter​(java.lang.String parameter, java.lang.String wert)
      setzt einen Startparameter des Skripts.
      Die Namen für einen Parameter sind eindeutig, d.h. beim Aufruf eines Skripts kann der gleiche Parameter nicht mehrfach verwendet werden.
      void setPasswd​(java.lang.String passwd)
      setzt das Passwort für die Anmeldung beim Datenverteiler bei der Ausführung des zugeordneten Skripts.
      void setSkript​(Skript skript)
      setzt das zugeordnete Skript des Skriptlaufs.
      void setStartTyp​(StartTyp typ)
      setzt den Starttyp für das Skript.
      void setStatus​(SkriptLaufStatus status)
      setzt den Ausführungsstatus des Skripts.
      void setZyklus​(StartZyklus zyklus)
      setzt den Startzyklus für die Ausführung des Skriptlaufs.
      java.lang.String toString()
      .
      Die Funktion liefert den Namen des Skriptlaufs.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • SkriptLauf

        public SkriptLauf()
    • Method Detail

      • addHistorie

        public void addHistorie​(Historie eintrag)
        fügt dem Skript einen Historie-Eintrag hinzu.
        Parameters:
        eintrag - der neue Eintrag
      • addProtokoll

        public void addProtokoll​(Protokoll protokoll)
        fügt dem Skriptlauf eine Protokolldefinition hinzu.
        Parameters:
        protokoll - das Protokoll
      • ausgeben

        public void ausgeben​(ProtokollEintrag daten)
        gibt die übergebenen Daten über alle dem Skriptlauf zugewiesenen Ausgabakanäle aus.
        Parameters:
        daten - die auszugebenden Daten
      • clearHistorie

        public void clearHistorie()
        löscht die Liste der Historie-Einträge.
      • clearParameter

        public void clearParameter()
        löscht die Liste der Parameter des Skripts.
      • clearProtokolle

        public void clearProtokolle()
        entfernt alle für den Skriptlauf definierten Protokolleinträge.
      • getBenutzer

        public java.lang.String getBenutzer()
        liefert den Name des Benutzers mit dem die Anmeldung beim Datenverteiler bei der Asuführung des Skripts erfolgen soll.
        Returns:
        der Name
        See Also:
        setBenutzer(String)
      • getBeschreibung

        public java.lang.String getBeschreibung()
        liefert die erläuternde Beschreibung des Skriptlaufs.
        Returns:
        die Beschreibung
        See Also:
        setBeschreibung(String)
      • getHistorie

        public java.util.List<Historie> getHistorie()
        liefert die Liste der Einträge der Bearbeitungsgeschichte des Skripts.
        Returns:
        die Einträge
      • getModul

        public abstract Modul getModul()
        liefert das Modul, in dem der Skriptlauf definiert ist.
        Returns:
        das Modul
      • getParameter

        public java.util.Map<java.lang.String,​java.lang.String> getParameter()
        liefert die Liste der Parameter, mit denen das dem Skriptlauf zugeordnete Skript ausgeführt werden soll.
        Returns:
        parameter die Liste der Parameter
        See Also:
        setParameter(String, String)
      • getPasswd

        public java.lang.String getPasswd()
        liefert des Passwort düe die Anmeldung beim Datenverteiler bei der Ausführung des Skriptlaufs.
        Returns:
        das Passwort
        See Also:
        setPasswd(String)
      • getProtokolle

        public java.util.Collection<Protokoll> getProtokolle()
        liefert die Liste der Protokolle, die bei der Ausführung des Skripts erstellt werden sollen.
        Returns:
        protokoll die Liste der Protokolle
      • getSkript

        public Skript getSkript()
        liefert das dem Skriptlauf zugeordnete Skript.
        Returns:
        das Skript oder null, wenn kein Skript zugeordnet wurde.
        See Also:
        setSkript(Skript)
      • getSkriptParameter

        public java.util.Map<java.lang.String,​java.lang.String> getSkriptParameter()
        liefert die Liste der für das Skript definierten Parameter.
        Returns:
        die Liste der Parameter
      • getStartTyp

        public StartTyp getStartTyp()
        liefert den für das Skript definierten Starttyp.
        Returns:
        den Starttyp
        See Also:
        setStartTyp(StartTyp)
      • getZyklus

        public StartZyklus getZyklus()
        liefert die Daten für eine zyklische oder zeitgesteuerte Ausführung des Skriptlaufs.
        Returns:
        zyklus die Zyklusbeschreibung
        See Also:
        setZyklus(StartZyklus)
      • initialisiereProtokolle

        public void initialisiereProtokolle()
        initialisiert alle Protokolle vor der Ausführung des zugeordneten Skripts.
      • kopiereDaten

        public void kopiereDaten​(SkriptLauf quellLauf)
        die Funktion übernimmt die Daten des übergebenen Skriptlaufs.
        Parameters:
        quellLauf - der Skriptlauf, von dem die Daten übernommen werden sollen.
      • protokolleAbschliessen

        public void protokolleAbschliessen()
        schließt alle Protokolle des Skriptlaufs.
      • publiziereErgebnis

        public abstract void publiziereErgebnis​(java.lang.Exception fehler)
        veröffentlicht das Ergebnis eines Skriptlaufs.
        Parameters:
        fehler - die Ursache eines Skriptabbruchs oder null, wenn das Skript ordnungsgemäß beendet wurde.
      • removeParameter

        public void removeParameter​(java.lang.String parameter)
        entfernt den mit dem Namen benannten Parameter des Skripts.
        Parameters:
        parameter - der Parametername
      • removeProtokoll

        public void removeProtokoll​(Protokoll item)
        entfernt einen Protokolleintrag aus den Definitionen des Skriptlaufs.
        Parameters:
        item - die Protokolldefinition
      • setBenutzer

        public void setBenutzer​(java.lang.String benutzer)
        setzt den Namen des Benutzers, unter dessen Namen das Skript ausgeführt werden soll.
        Parameters:
        benutzer - der Name des Benutzers
        See Also:
        getBenutzer()
      • setBeschreibung

        public void setBeschreibung​(java.lang.String beschreibung)
        setzt den erläuternden Text des Skriptlaufs.
        Parameters:
        beschreibung - der beschreibende Text
        See Also:
        getBeschreibung()
      • setInterpreter

        public void setInterpreter​(UdaInterpreter interpreter)
        setzt den Interpreter, der den Skriptlauf ausführt.
        Parameters:
        interpreter - der Interpreter
        See Also:
        getInterpreter()
      • setName

        public void setName​(java.lang.String name)
        setzt den Namen des Skriptlaufs.
        Parameters:
        name - der Name
        See Also:
        getName()
      • setParameter

        public void setParameter​(java.lang.String parameter,
                                 java.lang.String wert)
        setzt einen Startparameter des Skripts.
        Die Namen für einen Parameter sind eindeutig, d.h. beim Aufruf eines Skripts kann der gleiche Parameter nicht mehrfach verwendet werden.
        Parameters:
        parameter - der Parametername
        wert - der Wert
        See Also:
        getParameter()
      • setPasswd

        public void setPasswd​(java.lang.String passwd)
        setzt das Passwort für die Anmeldung beim Datenverteiler bei der Ausführung des zugeordneten Skripts.
        Parameters:
        passwd - das Passwort
        See Also:
        getPasswd()
      • setSkript

        public void setSkript​(Skript skript)
        setzt das zugeordnete Skript des Skriptlaufs.
        Parameters:
        skript - das Skript
        See Also:
        getSkript()
      • setStartTyp

        public void setStartTyp​(StartTyp typ)
        setzt den Starttyp für das Skript.
        Parameters:
        typ - der Starttyp
        See Also:
        getStartTyp()
      • setStatus

        public void setStatus​(SkriptLaufStatus status)
        setzt den Ausführungsstatus des Skripts.
        Parameters:
        status - der Status
        See Also:
        getStatus()
      • setZyklus

        public void setZyklus​(StartZyklus zyklus)
        setzt den Startzyklus für die Ausführung des Skriptlaufs.
        Parameters:
        zyklus - der Zyklus
        See Also:
        getZyklus()
      • toString

        public java.lang.String toString()
        .
        Die Funktion liefert den Namen des Skriptlaufs.
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()