Package de.elo.mover.main

Class Rule

  • public class Rule
extends java.lang.Object

    Überschrift: Rule.

    Beschreibung: Objekt für eine ELOas-Regel.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018

    • Constructor Summary

      Constructors 
      Constructor Description
      Rule()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addIndex​(java.lang.String indexName, java.lang.String indexValue)
      Fügt einen neuen Index mit Namen und Wert hinzu.
      java.lang.String asXml()
      Gibt die aktullen Rule Daten im XML Format zurück.
      int getChangeMaskTo()
      Gibt die Zielmaskennummer für diese Regel zurück
      java.lang.String getDestPath()
      Gibt den Zielpfad der Regel zurück.
      java.lang.String getFolderMask()
      Vorgabemaske für neue Ordner: falls ein destination Pfad noch nicht vorhanden oder noch nicht vollständig vorhanden ist, wird er automatisch angelegt.
      int getIndexLines()
      Gibt die Anzahl der definierten Indexzeilen zurück, die durch diese Regel mit Werten gefüllt werden.
      java.lang.String getIndexName​(int index)
      Gibt den Namen zur n-ten Indexzeile zurück.
      java.util.ArrayList getIndexNames()
      Gibt eine Referenz auf die Liste der Indexnamen zurück.
      java.lang.String getIndexValue​(int index)
      Gibt den Wert zur n-ten Indezeile zurück.
      java.util.ArrayList<java.lang.String> getIndexValues()
      Gibt eine Referenz auf die Liste der Indexwerte zurück
      java.lang.String getRuleName()
      Gibt den Namen der Regel zurück.
      java.lang.String getRunCondition()
      Gibt die Ausführungsbedingung für die Regel zurück.
      java.lang.String getScriptText()
      Gibt die Skript-Notation der Regel zurück.
      java.lang.String getShortName()
      Gibt den Namen der Regel zurück.
      boolean isErrorRule()
      Meldet zurück, ob eine Regel eine Ausführungs- oder eine Fehlerregel ist.
      boolean isScript()
      Zeigt an, ob eine Regel über die GUI oder über ein Skript definiert ist.
      void setChangeMaskTo​(int value)
      Setzt die Zielmaskennummer für diese Regel
      void setDestPath​(java.lang.String value)
      Setzt den Zielpfad der Regel
      void setFolderMask​(java.lang.String value)
      Setzt die Ordnermaske für neue Ordner im destination Pfad.
      void setIndexNames​(java.util.ArrayList<java.lang.String> indexNames)
      Setzt eine neue Liste mit Indexnamen.
      void setIndexValues​(java.util.ArrayList<java.lang.String> indexValues)
      Setzt eine neue Liste mit Indexwerten.
      void setRuleName​(java.lang.String value)
      Setzt den Namen der Regel
      void setRunCondition​(java.lang.String value)
      Setzt die Ausführungsbedingung der Regel
      void setScriptText​(java.lang.String value)
      Setzt den JavaScript Code für die Regel.
      void setShortName​(java.lang.String value)
      Setzt den Namen der Regel

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Rule

        public Rule()

    • Method Detail

      • isScript

        public boolean isScript()
        Zeigt an, ob eine Regel über die GUI oder über ein Skript definiert ist.
        Returns:
        True: ist ein Skript

      • isErrorRule

        public boolean isErrorRule()
        Meldet zurück, ob eine Regel eine Ausführungs- oder eine Fehlerregel ist. Fehlerregeln haben in RunCondition Feld den festen Text "OnError" stehen. Sie werden im normalen Betrieb einfach übersprungen. Im Fehlerfall wird die nächste Fehlerregel ausgeführt und anschließend die Bearbeitung dieses Rulesets abgebrochen.
        Returns:
        Ist Fehlerregel

      • getFolderMask

        public java.lang.String getFolderMask()
        Vorgabemaske für neue Ordner: falls ein destination Pfad noch nicht vorhanden oder noch nicht vollständig vorhanden ist, wird er automatisch angelegt. Für die neuen Ordner wird die hier definierte Maske verwendet.
        Returns:
        Ordnermaske

      • setFolderMask

        public void setFolderMask​(java.lang.String value)
        Setzt die Ordnermaske für neue Ordner im destination Pfad.
        Parameters:
        value - Ordnermaske

      • getDestPath

        public java.lang.String getDestPath()
        Gibt den Zielpfad der Regel zurück. Dieser liegt in einer JavaScript Notation vor.
        Returns:
        Zielpfad

      • setDestPath

        public void setDestPath​(java.lang.String value)
        Setzt den Zielpfad der Regel
        Parameters:
        value - Zielpfad

      • getRunCondition

        public java.lang.String getRunCondition()
        Gibt die Ausführungsbedingung für die Regel zurück. Diese liegt in einer JavaScript Notation vor.
        Returns:
        Bedingung

      • setRunCondition

        public void setRunCondition​(java.lang.String value)
        Setzt die Ausführungsbedingung der Regel
        Parameters:
        value - Bedingung

      • getChangeMaskTo

        public int getChangeMaskTo()
        Gibt die Zielmaskennummer für diese Regel zurück
        Returns:
        neue Maskennummer

      • setChangeMaskTo

        public void setChangeMaskTo​(int value)
        Setzt die Zielmaskennummer für diese Regel
        Parameters:
        value - neue Maskennummer

      • getRuleName

        public java.lang.String getRuleName()
        Gibt den Namen der Regel zurück.
        Returns:
        Name

      • getShortName

        public java.lang.String getShortName()
        Gibt den Namen der Regel zurück.
        Returns:
        Name

      • setRuleName

        public void setRuleName​(java.lang.String value)
        Setzt den Namen der Regel
        Parameters:
        value - Name

      • setShortName

        public void setShortName​(java.lang.String value)
        Setzt den Namen der Regel
        Parameters:
        value - Name

      • getScriptText

        public java.lang.String getScriptText()
        Gibt die Skript-Notation der Regel zurück. Dieser Wert ist nur vorhanden, wenn er vorher durch setScriptText gesetzt wurde. In diesem Fall ist isScript TRUE. Diese Funktion liefert nicht den generierten Code für die GUI Darstellung sondern nur den explizit anwenderdefinierten Code.
        Returns:
        JavaScript Code für die Regel

      • setScriptText

        public void setScriptText​(java.lang.String value)
        Setzt den JavaScript Code für die Regel. In diesem Fall wird dieser für die weitere Verarbeitung verwendet, die GUI Definition bleibt unbeachtet.
        Parameters:
        value - JavaScript Code

      • getIndexLines

        public int getIndexLines()
        Gibt die Anzahl der definierten Indexzeilen zurück, die durch diese Regel mit Werten gefüllt werden.
        Returns:
        Anzahl Zeilen

      • getIndexNames

        public java.util.ArrayList getIndexNames()
        Gibt eine Referenz auf die Liste der Indexnamen zurück.
        Returns:
        Aktuelle Indexnamen

      • setIndexNames

        public void setIndexNames​(java.util.ArrayList<java.lang.String> indexNames)
        Setzt eine neue Liste mit Indexnamen. Diese Funktion muss entweder im Paar mit setIndexValues aufgerufen werden oder die originale Anzahl, Anordnung und Zuordnung der Indexwerte zu Indexnamen muss unverändert bleiben. Wenn die Funktion alleine aufgerufen wird, dann darf nur ein oder mehrere Indexnamen abgeändert werden, es dürfen keine Namen hinzugefügt oder entfernt werden.
        Parameters:
        indexNames - Neue Indexnamen

      • getIndexValues

        public java.util.ArrayList<java.lang.String> getIndexValues()
        Gibt eine Referenz auf die Liste der Indexwerte zurück
        Returns:
        Aktuelle Indexwerte

      • setIndexValues

        public void setIndexValues​(java.util.ArrayList<java.lang.String> indexValues)
        Setzt eine neue Liste mit Indexwerten. Diese Funktion muss entweder im Paar mit setIndexNames aufgerufen werden oder die originale Anzahl, Anordnung und Zuordnung der Indexwerte zu Indexnamen muss unverändert bleiben. Wenn die Funktion alleine aufgerufen wird, dann darf nur ein oder mehrere Indexwerte abgeändert werden, es dürfen keine Werte hinzugefügt oder entfernt werden.
        Parameters:
        indexValues - Neue Indexwerte.

      • getIndexName

        public java.lang.String getIndexName​(int index)
        Gibt den Namen zur n-ten Indexzeile zurück.
        Parameters:
        index - Nummer der Indexzeile
        Returns:
        Name der Indexzeile

      • getIndexValue

        public java.lang.String getIndexValue​(int index)
        Gibt den Wert zur n-ten Indezeile zurück.
        Parameters:
        index - Nummer der Indexzeile
        Returns:
        Wert der Indexzeile

      • addIndex

        public void addIndex​(java.lang.String indexName,
                     java.lang.String indexValue)
        Fügt einen neuen Index mit Namen und Wert hinzu.
        Parameters:
        indexName - Name
        indexValue - Wert

      • asXml

        public java.lang.String asXml()
        Gibt die aktullen Rule Daten im XML Format zurück.
        Returns:
        Regeldaten im XML-Format