Package de.elo.mover.main.helper

Class DocMaskHelper

java.lang.Object
de.elo.mover.main.helper.DocMaskHelper
public class DocMaskHelper
extends java.lang.Object

Überschrift: DocMaskHelper.

Beschreibung: Hilfsklasse für den Zugriff auf Dokumentenmasken.

Copyright: Copyright (c) ELO Digital Office GmbH 2018 - 2020

  • Constructor Summary

    Constructors 
    Constructor Description
    DocMaskHelper()  

  • Method Summary

    Modifier and Type Method Description
    static de.elo.ix.client.DocMaskLine createDocMaskLine()
    Erzeugt ein neues Feld mit allen Berechtigungen.
    static java.util.ArrayList<de.elo.ix.client.MaskName> getBarcodeMasks​(IXconnect ixConnect)
    Liefert eine Liste mit den Maskennamen mit einer Barcodedefinition zurück.
    static java.util.ArrayList<de.elo.ix.client.DocMaskLine> getDateLines​(IXconnect ixConnect, int maskId)
    Liefert eine Liste mit den Datumsfeldern der angegebenen Maske zurück.
    static java.util.ArrayList<de.elo.ix.client.MaskName> getDocumentMasks​(IXconnect ixConnect)
    Liefert eine Liste mit den Dokumentenmasken zurück.
    static java.util.ArrayList<de.elo.ix.client.MaskName> getFolderMasks​(IXconnect ixConnect)
    Liefert eine Liste mit den Ordnermasken zurück.
    static java.util.List<java.lang.String> getGuids​(de.elo.ix.client.MaskName[] maskNames)
    Liefert eine Liste mit den Masken-GUIDs zurück.
    static java.util.List<java.lang.Integer> getIds​(de.elo.ix.client.MaskName[] maskNames)
    Liefert eine Liste mit den Masken-IDs zurück.
    static java.util.List<java.lang.String> getIdsAsString​(de.elo.ix.client.MaskName[] maskNames)
    Liefert eine Liste mit den Masken-IDs als Strings zurück.
    static java.util.List<java.lang.String> getLineNames​(de.elo.ix.client.DocMask mask)
    Liefert eine Liste mit den Namen der Felder der angegebenen Maske zurück.
    static de.elo.ix.client.DocMaskLine getMaskLine​(de.elo.ix.client.DocMask mask, int lineNr)
    Gibt das "DocMaskLine"-Objekt für das angegebene Feld zurück.
    static de.elo.ix.client.MaskName[] getMaskNames​(IXconnect ixConnect)
    Liefert eine Liste mit den vorhandenen Maskennamen zurück.
    static int getMaxIndex​(de.elo.ix.client.DocMask mask)
    Liefert die Nummer des letzten definierten Maskenfeldes zurück.
    static java.util.List<java.lang.String> getNames​(de.elo.ix.client.MaskName[] maskNames)
    Liefert eine Liste mit den Maskenbezeichnungen zurück.
    static java.util.ArrayList<de.elo.ix.client.DocMaskLine> getNumberLines​(IXconnect ixConnect, int maskId)
    Liefert eine Liste mit den nummerischen Feldern der angegebenen Maske zurück.
    static int getObjectMaskId​(IXconnect ixConnect, int objId)
    Liefert die Maske des angegebenen Eintrags zurück.
    static java.lang.String getObjectMaskName​(IXconnect ixConnect, int objId)
    Liefert die Maskenbezeichnung des angegebenen Eintrags zurück.
    static java.util.ArrayList<de.elo.ix.client.MaskName> getSearchMasks​(IXconnect ixConnect)
    Liefert eine Liste mit den Suchmasken zurück.
    static boolean isAutomatedArchiving​(IXconnect ixConnect, int maskId)
    Meldet zurück, ob die angegebene Maske für die automatische Ablage eingestellt ist.
    static boolean isAutomatedArchiving​(IXconnect ixConnect, java.lang.String maskName)
    Meldet zurück, ob die angegebene Maske für die automatische Ablage eingestellt ist.
    static boolean isDate​(de.elo.ix.client.DocMaskLine maskLine)
    Meldet zurück, ob das angegebene Feld vom Typ Datum ist.
    static boolean isDynamicKeywordList​(de.elo.ix.client.DocMaskLine maskLine)
    Prüft, ob das angegebene Feld dynamische Stichwortlisten verwendet.
    static boolean isIsoDate​(de.elo.ix.client.DocMaskLine maskLine)
    Prüft ob das angegebene Feld vom Typ ISO-Datum ist.
    static boolean isNumber​(de.elo.ix.client.DocMaskLine maskLine)
    Prüft ob das angegebene Feld von einem numerischen Typ ist.
    static boolean isNumberDouble​(de.elo.ix.client.DocMaskLine maskLine)
    Meldet zurück, ob das angegebene Feld vom Typ "Double" ist.
    static boolean isNumberInteger​(de.elo.ix.client.DocMaskLine maskLine)
    Meldet zurück, ob das angegebene Feld vom Typ "Integer" ist.
    static boolean isRelation​(de.elo.ix.client.DocMaskLine maskLine)
    Prüft, ob das angegebene Feld vom Typ "Relation" ist.
    static java.lang.String maskNameToString​(de.elo.ix.client.MaskName maskName)
    Liefert die Beschreibung der angegebenen Maske zurück.
    static void setAccess​(de.elo.ix.client.DocMaskLine maskLine)
    Setzt alle Rechte für das angegebene Feld falls keine Rechte vorhanden sind.
    static void setDocumentFolderMask​(IXconnect ixConnect, int maskId)
    Setzt die angegebene Maske als eine Dokument/Ordnermaske.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • getLineNames

      public static java.util.List<java.lang.String> getLineNames​(de.elo.ix.client.DocMask mask) throws java.lang.Exception
      Liefert eine Liste mit den Namen der Felder der angegebenen Maske zurück.
      Parameters:
      mask - Maske
      Returns:
      Liste mit den Bezeichnungen der Felder
      Throws:
      java.lang.Exception

    • getNames

      public static java.util.List<java.lang.String> getNames​(de.elo.ix.client.MaskName[] maskNames) throws java.lang.Exception
      Liefert eine Liste mit den Maskenbezeichnungen zurück.
      Parameters:
      maskNames - Liste mit MaskName-Objekten
      Returns:
      Liste mit Maskenbezeichnungen
      Throws:
      java.lang.Exception

    • getIds

      public static java.util.List<java.lang.Integer> getIds​(de.elo.ix.client.MaskName[] maskNames) throws java.lang.Exception
      Liefert eine Liste mit den Masken-IDs zurück.
      Parameters:
      maskNames - Liste mit MaskName-Objekten
      Returns:
      Liste mit Masken-IDs
      Throws:
      java.lang.Exception

    • getGuids

      public static java.util.List<java.lang.String> getGuids​(de.elo.ix.client.MaskName[] maskNames) throws java.lang.Exception
      Liefert eine Liste mit den Masken-GUIDs zurück.
      Parameters:
      maskNames - Liste mit MaskName-Objekten
      Returns:
      Liste mit Masken-GUIDs
      Throws:
      java.lang.Exception

    • getIdsAsString

      public static java.util.List<java.lang.String> getIdsAsString​(de.elo.ix.client.MaskName[] maskNames) throws java.lang.Exception
      Liefert eine Liste mit den Masken-IDs als Strings zurück.
      Parameters:
      maskNames - Liste mit MaskName-Objekten
      Returns:
      Liste mit Masken-IDs
      Throws:
      java.lang.Exception

    • getMaxIndex

      public static int getMaxIndex​(de.elo.ix.client.DocMask mask) throws java.lang.Exception
      Liefert die Nummer des letzten definierten Maskenfeldes zurück.
      Parameters:
      mask - Zu prüfende Maske
      Returns:
      Letzter Index
      Throws:
      java.lang.Exception

    • getMaskLine

      public static de.elo.ix.client.DocMaskLine getMaskLine​(de.elo.ix.client.DocMask mask, int lineNr) throws java.lang.Exception
      Gibt das "DocMaskLine"-Objekt für das angegebene Feld zurück.
      Parameters:
      mask - Maske mit allen Feldern
      lineNr - Gesuchte Zeilennummer
      Returns:
      DocMaskLine Maskenfeld
      Throws:
      java.lang.Exception

    • getMaskNames

      public static de.elo.ix.client.MaskName[] getMaskNames​(IXconnect ixConnect) throws java.lang.Exception
      Liefert eine Liste mit den vorhandenen Maskennamen zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Liste mit Maskennamen
      Throws:
      java.lang.Exception

    • getDocumentMasks

      public static java.util.ArrayList<de.elo.ix.client.MaskName> getDocumentMasks​(IXconnect ixConnect) throws java.lang.Exception
      Liefert eine Liste mit den Dokumentenmasken zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Liste mit den Dokumentmasken
      Throws:
      java.lang.Exception

    • getFolderMasks

      public static java.util.ArrayList<de.elo.ix.client.MaskName> getFolderMasks​(IXconnect ixConnect) throws java.lang.Exception
      Liefert eine Liste mit den Ordnermasken zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Liste mit den Ordnermasken
      Throws:
      java.lang.Exception

    • getSearchMasks

      public static java.util.ArrayList<de.elo.ix.client.MaskName> getSearchMasks​(IXconnect ixConnect) throws java.lang.Exception
      Liefert eine Liste mit den Suchmasken zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Liste mit den Suchmasken
      Throws:
      java.lang.Exception

    • getBarcodeMasks

      public static java.util.ArrayList<de.elo.ix.client.MaskName> getBarcodeMasks​(IXconnect ixConnect) throws java.lang.Exception
      Liefert eine Liste mit den Maskennamen mit einer Barcodedefinition zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      Returns:
      Liste mit den Barcode-Masken
      Throws:
      java.lang.Exception

    • isAutomatedArchiving

      public static boolean isAutomatedArchiving​(IXconnect ixConnect, int maskId) throws java.lang.Exception
      Meldet zurück, ob die angegebene Maske für die automatische Ablage eingestellt ist.
      Parameters:
      ixConnect - Indexserver-Verbindung
      maskId - ID der Maske
      Returns:
      Maske ist für die automatische Ablage eingestellt
      Throws:
      java.lang.Exception

    • isAutomatedArchiving

      public static boolean isAutomatedArchiving​(IXconnect ixConnect, java.lang.String maskName) throws java.lang.Exception
      Meldet zurück, ob die angegebene Maske für die automatische Ablage eingestellt ist.
      Parameters:
      ixConnect - Indexserver-Verbindung
      maskName - Name der Maske
      Returns:
      Maske ist für die automatische Ablage eingestellt
      Throws:
      java.lang.Exception

    • isNumber

      public static boolean isNumber​(de.elo.ix.client.DocMaskLine maskLine) throws java.lang.Exception
      Prüft ob das angegebene Feld von einem numerischen Typ ist.
      Parameters:
      maskLine - Feld einer Maske
      Returns:
      True bei numerisch, False sonst
      Throws:
      java.lang.Exception

    • isNumberInteger

      public static boolean isNumberInteger​(de.elo.ix.client.DocMaskLine maskLine) throws java.lang.Exception
      Meldet zurück, ob das angegebene Feld vom Typ "Integer" ist.
      Parameters:
      maskLine - Feld einer Maske
      Returns:
      True bei einem Integer-Feld, False sonst
      Throws:
      java.lang.Exception

    • isNumberDouble

      public static boolean isNumberDouble​(de.elo.ix.client.DocMaskLine maskLine) throws java.lang.Exception
      Meldet zurück, ob das angegebene Feld vom Typ "Double" ist.
      Parameters:
      maskLine - Feld einer Maske
      Returns:
      True bei einem Double-Feld, False sonst
      Throws:
      java.lang.Exception

    • getNumberLines

      public static java.util.ArrayList<de.elo.ix.client.DocMaskLine> getNumberLines​(IXconnect ixConnect, int maskId) throws java.lang.Exception
      Liefert eine Liste mit den nummerischen Feldern der angegebenen Maske zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      maskId - ID der Maske
      Returns:
      Liste mit nummerischen Feldern
      Throws:
      java.lang.Exception

    • isDate

      public static boolean isDate​(de.elo.ix.client.DocMaskLine maskLine) throws java.lang.Exception
      Meldet zurück, ob das angegebene Feld vom Typ Datum ist.
      Parameters:
      maskLine - Feld einer Maske
      Returns:
      True bei einem Datumsfeld, False sonst
      Throws:
      java.lang.Exception

    • isIsoDate

      public static boolean isIsoDate​(de.elo.ix.client.DocMaskLine maskLine) throws java.lang.Exception
      Prüft ob das angegebene Feld vom Typ ISO-Datum ist.
      Parameters:
      maskLine - Feld einer Maske
      Returns:
      True bei ISO-Datum, False sonst
      Throws:
      java.lang.Exception

    • getDateLines

      public static java.util.ArrayList<de.elo.ix.client.DocMaskLine> getDateLines​(IXconnect ixConnect, int maskId) throws java.lang.Exception
      Liefert eine Liste mit den Datumsfeldern der angegebenen Maske zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      maskId - ID der Maske
      Returns:
      Liste mit Datumsfeldern
      Throws:
      java.lang.Exception

    • isRelation

      public static boolean isRelation​(de.elo.ix.client.DocMaskLine maskLine) throws java.lang.Exception
      Prüft, ob das angegebene Feld vom Typ "Relation" ist.
      Parameters:
      maskLine - Feld einer Maske
      Returns:
      True bei einem Relationsfeld, False sonst
      Throws:
      java.lang.Exception

    • isDynamicKeywordList

      public static boolean isDynamicKeywordList​(de.elo.ix.client.DocMaskLine maskLine) throws java.lang.Exception
      Prüft, ob das angegebene Feld dynamische Stichwortlisten verwendet. Dynamische Stichwortlisten sind anhand des Typs "Relation" oder eines Indexserver-Skripts erkennbar.
      Parameters:
      maskLine - Feld einer Maske
      Returns:
      True, wenn dynamische Stichwortlisten verwendet werden, False sonst
      Throws:
      java.lang.Exception

    • createDocMaskLine

      public static de.elo.ix.client.DocMaskLine createDocMaskLine()
      Erzeugt ein neues Feld mit allen Berechtigungen.
      Returns:
      Neues Maskenfeld

    • setAccess

      public static void setAccess​(de.elo.ix.client.DocMaskLine maskLine) throws java.lang.Exception
      Setzt alle Rechte für das angegebene Feld falls keine Rechte vorhanden sind.
      Parameters:
      maskLine - Maskenfeld
      Throws:
      java.lang.Exception

    • getObjectMaskId

      public static int getObjectMaskId​(IXconnect ixConnect, int objId) throws java.lang.Exception
      Liefert die Maske des angegebenen Eintrags zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      Returns:
      Maske ID
      Throws:
      java.lang.Exception

    • getObjectMaskName

      public static java.lang.String getObjectMaskName​(IXconnect ixConnect, int objId) throws java.lang.Exception
      Liefert die Maskenbezeichnung des angegebenen Eintrags zurück.
      Parameters:
      ixConnect - Indexserver-Verbindung
      objId - ID des Eintrags
      Returns:
      Maskenbezeichnung
      Throws:
      java.lang.Exception

    • maskNameToString

      public static java.lang.String maskNameToString​(de.elo.ix.client.MaskName maskName) throws java.lang.Exception
      Liefert die Beschreibung der angegebenen Maske zurück.
      Parameters:
      maskName - Maske
      Returns:
      Beschreibung der Maske
      Throws:
      java.lang.Exception

    • setDocumentFolderMask

      public static void setDocumentFolderMask​(IXconnect ixConnect, int maskId) throws java.lang.Exception
      Setzt die angegebene Maske als eine Dokument/Ordnermaske.
      Parameters:
      ixConnect - Indexserver-Verbindung
      maskId - ID der Maske
      Throws:
      java.lang.Exception