Package de.elo.mover.main.helper

Class DocMaskHelper

java.lang.Object
de.elo.mover.main.helper.DocMaskHelper
public class DocMaskHelper extends 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 ArrayList<de.elo.ix.client.MaskName>
    getBarcodeMasks(IXconnect ixConnect)
    Liefert eine Liste mit den Maskennamen mit einer Barcodedefinition zurück.
    static ArrayList<de.elo.ix.client.DocMaskLine>
    getDateLines(IXconnect ixConnect, int maskId)
    Liefert eine Liste mit den Datumsfeldern der angegebenen Maske zurück.
    static ArrayList<de.elo.ix.client.MaskName>
    getDocumentMasks(IXconnect ixConnect)
    Liefert eine Liste mit den Dokumentenmasken zurück.
    static ArrayList<de.elo.ix.client.MaskName>
    getFolderMasks(IXconnect ixConnect)
    Liefert eine Liste mit den Ordnermasken zurück.
    static List<String>
    getGuids(de.elo.ix.client.MaskName[] maskNames)
    Liefert eine Liste mit den Masken-GUIDs zurück.
    static List<Integer>
    getIds(de.elo.ix.client.MaskName[] maskNames)
    Liefert eine Liste mit den Masken-IDs zurück.
    static List<String>
    getIdsAsString(de.elo.ix.client.MaskName[] maskNames)
    Liefert eine Liste mit den Masken-IDs als Strings zurück.
    static List<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 List<String>
    getNames(de.elo.ix.client.MaskName[] maskNames)
    Liefert eine Liste mit den Maskenbezeichnungen zurück.
    static 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 String
    getObjectMaskName(IXconnect ixConnect, int objId)
    Liefert die Maskenbezeichnung des angegebenen Eintrags zurück.
    static 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, 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 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

    • DocMaskHelper

      public DocMaskHelper()

  • Method Details

    • getLineNames

      public static List<String> getLineNames(de.elo.ix.client.DocMask mask) throws 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:
      Exception

    • getNames

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

    • getIds

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

    • getGuids

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

    • getIdsAsString

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

    • getMaxIndex

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

    • getMaskLine

      public static de.elo.ix.client.DocMaskLine getMaskLine(de.elo.ix.client.DocMask mask, int lineNr) throws 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:
      Exception

    • getMaskNames

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

    • getDocumentMasks

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

    • getFolderMasks

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

    • getSearchMasks

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

    • getBarcodeMasks

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

    • isAutomatedArchiving

      public static boolean isAutomatedArchiving(IXconnect ixConnect, int maskId) throws 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:
      Exception

    • isAutomatedArchiving

      public static boolean isAutomatedArchiving(IXconnect ixConnect, String maskName) throws 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:
      Exception

    • isNumber

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

    • isNumberInteger

      public static boolean isNumberInteger(de.elo.ix.client.DocMaskLine maskLine) throws 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:
      Exception

    • isNumberDouble

      public static boolean isNumberDouble(de.elo.ix.client.DocMaskLine maskLine) throws 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:
      Exception

    • getNumberLines

      public static ArrayList<de.elo.ix.client.DocMaskLine> getNumberLines(IXconnect ixConnect, int maskId) throws 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:
      Exception

    • isDate

      public static boolean isDate(de.elo.ix.client.DocMaskLine maskLine) throws 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:
      Exception

    • isIsoDate

      public static boolean isIsoDate(de.elo.ix.client.DocMaskLine maskLine) throws 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:
      Exception

    • getDateLines

      public static ArrayList<de.elo.ix.client.DocMaskLine> getDateLines(IXconnect ixConnect, int maskId) throws 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:
      Exception

    • isRelation

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

    • isDynamicKeywordList

      public static boolean isDynamicKeywordList(de.elo.ix.client.DocMaskLine maskLine) throws 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:
      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 Exception
      Setzt alle Rechte für das angegebene Feld falls keine Rechte vorhanden sind.
      Parameters:
      maskLine - Maskenfeld
      Throws:
      Exception

    • getObjectMaskId

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

    • getObjectMaskName

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

    • maskNameToString

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

    • setDocumentFolderMask

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