Package de.elo.mover.main.helper

Class 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

    • Constructor Summary

      Constructors 
      Constructor Description
      DocMaskHelper()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static de.elo.ix.client.DocMaskLine createDocMaskLine()
      Erzeugt eine neue Indexzeile 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 Verschlagwortungsmaske 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 Indexzeilen der angegebenen Verschlagwortungsmaske zurück.
      static de.elo.ix.client.DocMaskLine getMaskLine​(de.elo.ix.client.DocMask mask, int lineNr)
      Gibt das DocMaskLine-Objekt für die bestimmte Zeile 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 Indexfeldes 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 Indexfeldern der angegebenen Verschlagwortungsmaske zurück.
      static int getObjectMaskId​(IXconnect ixConnect, int objId)
      Liefert die Maske des angegebenen Archiveintrags zurück.
      static java.lang.String getObjectMaskName​(IXconnect ixConnect, int objId)
      Liefert die Maskenbezeichnung des angegebenen Archiveintrags 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 Archivierung eingestellt ist.
      static boolean isAutomatedArchiving​(IXconnect ixConnect, java.lang.String maskName)
      Meldet zurück, ob die angegebene Maske für die automatische Archivierung eingestellt ist.
      static boolean isDate​(de.elo.ix.client.DocMaskLine maskLine)
      Meldet zurück, ob das angegebene Indexfeld vom Typ Datum ist.
      static boolean isDynamicKeywordList​(de.elo.ix.client.DocMaskLine maskLine)
      Prüft, ob das angegebene Indexfeld dynamische Stichwortlisten verwendet.
      static boolean isIsoDate​(de.elo.ix.client.DocMaskLine maskLine)
      Prüft ob das angegebene Indexfeld vom Typ ISO-Datum ist.
      static boolean isNumber​(de.elo.ix.client.DocMaskLine maskLine)
      Prüft ob das angegebene Indexfeld von einem numerischen Typ ist.
      static boolean isNumberDouble​(de.elo.ix.client.DocMaskLine maskLine)
      Meldet zurück, ob das angegebene Indexfeld vom Typ "Double" ist.
      static boolean isNumberInteger​(de.elo.ix.client.DocMaskLine maskLine)
      Meldet zurück, ob das angegebene Indexfeld vom Typ "Integer" ist.
      static boolean isRelation​(de.elo.ix.client.DocMaskLine maskLine)
      Prüft, ob das angegebene Indexfeld vom Typ "Relation" ist.
      static java.lang.String maskNameToString​(de.elo.ix.client.MaskName maskName)
      Liefert die Beschreibung der angegebenen Verschlagwortungsmaske zurück.
      static void setAccess​(de.elo.ix.client.DocMaskLine maskLine)
      Setzt alle Rechte für die angegebene Indexzeile falls keine Rechte vorhanden sind.
      static void setDocumentFolderMask​(IXconnect ixConnect, int maskId)
      Setzt die angegebene Verschlagwortungsmaske als eine Dokument/Ordnermaske.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DocMaskHelper

        public DocMaskHelper()

    • Method Detail

      • 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 Indexzeilen der angegebenen Verschlagwortungsmaske zurück.
        Parameters:
        mask - Verschlagwortungsmaske
        Returns:
        Liste mit den Bezeichnungen der Indexzeilen
        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 Indexfeldes 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 die bestimmte Zeile zurück.
        Parameters:
        mask - Maske mit allen Indexzeilen
        lineNr - Gesuchte Zeilennummer
        Returns:
        DocMaskLine Zeile der Verschlagwortungsmaske
        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 - Index Server 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 - Index Server 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 - Index Server 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 - Index Server 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 - Index Server Verbindung
        Returns:
        Liste mit den Barcodemasken
        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 Archivierung eingestellt ist.
        Parameters:
        ixConnect - Index Server Verbindung
        maskId - ID der Verschlagwortungsmaske
        Returns:
        Maske ist für die automatische Archivierung 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 Archivierung eingestellt ist.
        Parameters:
        ixConnect - Index Server Verbindung
        maskName - Name der Verschlagwortungsmaske
        Returns:
        Maske ist für die automatische Archivierung 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 Indexfeld von einem numerischen Typ ist.
        Parameters:
        maskLine - Indexzeile 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 Indexfeld vom Typ "Integer" ist.
        Parameters:
        maskLine - Indexzeile einer Maske
        Returns:
        True bei einer Integer-Indexzeile, 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 Indexfeld vom Typ "Double" ist.
        Parameters:
        maskLine - Indexzeile einer Maske
        Returns:
        True bei einer Double-Indexzeile, 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 Indexfeldern der angegebenen Verschlagwortungsmaske zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        maskId - ID der Verschlagwortungsmaske
        Returns:
        Liste mit nummerischen Indexfeldern
        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 Indexfeld vom Typ Datum ist.
        Parameters:
        maskLine - Indexzeile einer Maske
        Returns:
        True wenn 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 Indexfeld vom Typ ISO-Datum ist.
        Parameters:
        maskLine - Indexzeile 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 Verschlagwortungsmaske zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        maskId - ID der Verschlagwortungsmaske
        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 Indexfeld vom Typ "Relation" ist.
        Parameters:
        maskLine - Indexzeile 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 Indexfeld dynamische Stichwortlisten verwendet. Dynamische Stichwortlisten sind anhand des Typs "Relation" oder eines Index Server Skripts erkennbar.
        Parameters:
        maskLine - Indexzeile 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 eine neue Indexzeile mit allen Berechtigungen.
        Returns:
        Neue Indexzeile

      • setAccess

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

      • getObjectMaskId

        public static int getObjectMaskId​(IXconnect ixConnect,
                                  int objId)
                           throws java.lang.Exception
        Liefert die Maske des angegebenen Archiveintrags zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        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 Archiveintrags zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        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 Verschlagwortungsmaske zurück.
        Parameters:
        maskName - Verschlagwortungsmaske
        Returns:
        Beschreibung der Verschlagwortungsmaske
        Throws:
        java.lang.Exception

      • setDocumentFolderMask

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