Package de.elo.mover.utils

Class ELOAsUtils

  • public class ELOAsUtils
extends java.lang.Object

    Überschrift: ELOAsUtils.

    Beschreibung: Hilfsklasse für den ELO Automation Service.

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

    • Constructor Summary

      Constructors 
      Constructor Description
      ELOAsUtils()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void addAttachment​(IXconnect ixConnect, int objId, java.io.File sourceFile)
      Fügt eine Dateianbindung an das angegebene Archivelement.
      static int addDynamicFolder​(IXconnect ixConnect, java.lang.String folderName, int parentId, java.lang.String maskName, java.lang.String descr)
      Erstellt einen dynamischen Register im angegebenen Ordner.
      static int addNewFolder​(IXconnect ixConnect, java.lang.String folderName, int parentId, java.lang.String maskName)
      Erzeugt einen neuen Ordner im angegebenen Archivordner.
      static void addReportEntry​(IXconnect ixConnect, int objId, int actionNo, int extra1, int extra2, java.lang.String message)
      Schreibt einen Report Eintrag in die Datenbank.
      static boolean archivePathExists​(IXconnect ixConnect, java.lang.String archivePath)
      Meldet zurück, ob der angegebene Archivpfad existiert.
      static boolean archivePathIsValid​(java.lang.String archivePath)
      Meldet zurück, ob der angegebene Pfad gültig ist (kein leerer String).
      static int checkEntryChecksum​(IXconnect ixConnect, de.elo.ix.client.Sord sord)
      Überprüft die CheckSumme des angegebenen Archiveintrags.
      static int[] checkEntryChecksumVersions​(IXconnect ixConnect, de.elo.ix.client.Sord sord)
      Überprüft die CheckSumme von allen Versionen des angegebenen Archiveintrags.
      static boolean checkOcrAvail​(IXconnect ixConnect)
      Meldet zurück, ob die OCR verfügbar ist.
      static int createArcPath​(IXconnect ixConnect, int parentId, java.lang.String path)
      Legt den angegebenen Archivpfad an.
      static BarcodeReader createBarcodeReader()
      Erzeugt ein Objekt für die Barcode-Erkennung.
      static BarcodeReader createBarcodeReader​(java.lang.String barcodeRulesDescr)
      Erzeugt ein Objekt für die Barcode-Erkennung.
      static BarcodeReader createBarcodeReader2​(IXconnect currIxConnect)
      Erzeugt ein Objekt für die Barcode-Erkennung.
      static de.elo.ix.client.EditInfo createDefaultEditInfo​(IXconnect ixConnect, java.io.File file, java.lang.String maskName, int targetId)
      Erzeugt eine Default-Verschlagwortung für die angegebene Datei.
      static java.util.ArrayList<de.elo.ix.client.PublicDownload> createExternalLinks​(IXconnect ixConnect, int[] objIds, int downloadCount, java.lang.String expiredIsoDate, boolean useShortName)
      Erstellt die externen Links für die angegebenen Dokumente und liefert diese zurück.
      static com.jcraft.jsch.Session createJschSession​(java.lang.String username, java.lang.String password, java.lang.String host, int port)
      Erzeugt ein JSCH Session-Objekt, mit dem eine Verbindung aufgebaut wird.
      static java.lang.String createMd5​(java.io.File file)
      Emittelt den MD5-Hash der angegebenen Datei.
      static de.elo.ix.client.StoreInfo createStorePath​(IXconnect ixConnect, java.lang.String storeName, java.lang.String directory)
      Legt den angegebenen Speicherpfad an, falls dieser nicht vorhanden ist.
      static void exportArchiveDocuments​(IXconnect ixConnect, int[] ids, java.io.File target, boolean zipFiles)
      Speichert die angegebenen Archivdokumente in einer ZIP-Datei oder in einem Ordner.
      static void exportArchiveDocuments​(IXconnect ixConnect, de.elo.ix.client.Sord[] sords, java.io.File target, boolean zipFiles, boolean useShortName)
      Speichert die angegebenen Archivdokumente in einer ZIP-Datei oder in einem Ordner.
      static de.elo.ix.client.EditInfo findDoublet​(IXconnect ixConnect, java.io.File file)
      Liefert die Verschlagwortungsinformationen der angegebenen Datei zurück.
      static java.lang.String fixElementPath​(java.lang.String path, de.elo.ix.client.Sord sord)
      Liefert einen vollständigen Archivpfad aus dem angegebenen Archivpfad und der Archiveintragsbezeichnung zurück.
      static java.lang.String getArchiveName​(IXconnect ixConnect)
      Liefert die Archivbezeichnung zurück.
      static java.util.ArrayList<java.lang.String> getAsLibrariesNames()
      Liefert eine Liste mit den Namen der vorhandenen AS-Libraries zurück.
      static java.lang.String getAsVersion()
      Liefert die aktuelle AS-Version zurück.
      static java.io.File getAttachmentVersion​(IXconnect ixConnect, int objId, java.io.File targetDir)
      Liefert die Arbeitsversion der Dateianbindung des angegebenen Archivdokuments zurück.
      static java.lang.String getBarcode​(IXconnect ixConnect, java.io.File file, int page, java.lang.String barcodeConfig)
      Liefert die Barcode-Informationen für die angegebene Datei zurück.
      static com.google.zxing.Result getBarcodeResult​(IXconnect ixConnect, java.io.File file, int page, java.lang.String barcodeConfig)
      Liefert die Barcode-Informationen für die angegebene Datei zurück.
      static ChecksumReport getChecksumReport​(IXconnect ixConnect, de.elo.ix.client.Sord[] sords, java.io.File reportFile, boolean logOnlyErrors)
      Überprüft die Check-Summe der angegebenen Archiveinträge.
      static java.lang.String getDefaultLang()
      Liefert die Default-Sprache zurück.
      static int getDefaultPathId​(IXconnect ixConnect)
      Liefert den Default-Ablagepfad zurück.
      static int getDocIdFromUploadResult​(java.lang.String uploadResult)
      Liefert die neue EloDM-DokumentenId aus dem angegebenen UploadResult zurück.
      static java.io.File getDocumentVersion​(IXconnect ixConnect, int objId, java.io.File targetDir)
      Liefert die Arbeitsversion des angegebenen Archivdokuments zurück.
      static void getDocumentVersionPart​(IXconnect ixConnect, int objId, java.io.File targetFile, long offset, long length)
      Lädt den angegebene Teil der Arbeitsversion herunter.
      static de.elo.ix.client.EditInfo getEditInfoFilingPaths​(IXconnect ixConnect)
      Liefert das EditInfo-Objekt mit den Ablagepfaden zurück.
      static de.elo.ix.client.Sord getElemByArcpath​(IXconnect ixConnect, java.lang.String arcPath)
      Liefert den Archiveintrag mit dem angegebenen Archivpfad zurück.
      static de.elo.ix.client.Sord getElemByArcpathRelative​(IXconnect ixConnect, int rootId, java.lang.String arcPath)
      Liefert den Archiveintrag über einen Archivpfad relativ zu einem Startordner zurück.
      static java.lang.String getElementPath​(IXconnect ixConnect, int objId)
      Liefert einen String mit dem Pfad zum angegebenen Archiveintrag zurück.
      static java.lang.String getElementPath​(IXconnect ixConnect, java.lang.String guid)
      Liefert einen String mit dem Pfad zum angegebenen Archiveintrag zurück.
      static java.lang.String[] getExternalOcrLanguages​(IXconnect ixConnect)
      Liefert die vorhandenen externen OCR-Sprachen zurück.
      static de.elo.ix.client.IdName[] getFilingPaths​(IXconnect ixConnect)
      Liefert die vorhandenen Ablagepfade zurück.
      static java.lang.String getFulltextContent​(IXconnect ixConnect, int objId)
      Liefert den Volltext-Inhalt des angegebenen Archiveintrags zurück.
      static java.io.File getFulltextFile​(IXconnect ixConnect, int objId, java.io.File targetDir)
      Erstellt eine Datei mit dem Volltext-Inhalt des Archivdokuments im angegebenen Verzeichnis.
      static java.lang.String[] getInternalOcrLanguages​(IXconnect ixConnect)
      Liefert die vorhandenen internen OCR-Sprachen zurück.
      static java.lang.String getJREString()
      Liefert Informationen zur Java Runtime Umgebung als formatierten String zurück.
      static int getLastDocumentId​(IXconnect ixConnect)
      Liefert die letzte physikalische Dokumentennummer im Archiv zurück.
      static int getObjIdFromPath​(IXconnect ixConnect, java.lang.String archivePath)
      Liefert die ID des Archiveintrags für den angegebenen Pfad zurück.
      static java.lang.String getOcrRect​(IXconnect ixConnect, int objId, java.lang.String[] langs, int pageNr, int top, int left, int bottom, int right)
      Liefert den durch die OCR erkannten Text vom angegebenen Rechteck zurück.
      static java.lang.String getOcrText​(IXconnect ixConnect, int objId, java.lang.String[] langs)
      Liefert den kompletten OCR-Text für das angegebene Archivdokument zurück.
      static java.lang.String getOcrTextForPage​(IXconnect ixConnect, java.lang.String objId, int pageNr, java.lang.String[] langs)
      Liefert den OCR-Text aus der angegebenen Dokumentseite zurück.
      static java.lang.String[] getParentNames​(IXconnect ixConnect, int objId)
      Liefert eine Liste mit den Namen der übergeordneten Archiveinträgen zurück.
      static de.elo.ix.client.Sord getPersonalFolder​(IXconnect ixConnect, int userId)
      Liefert die Verschlagwortung des Ordners "Persönlichen Bereich" zurück.
      static java.lang.String[] getReferencePaths​(IXconnect ixConnect, int objId)
      Liefert eine Liste mit den Referenzpfaden des angegebenen Archiveintrags zurück.
      static de.elo.ix.client.ReportInfo getReportInfo​(IXconnect ixConnect, int objId, int userId, int actionNo, java.lang.String comment, int extra1, int extra2, java.lang.String extraInfo)
      Erzeugt ein ReportInfo Objekt aus den angegebenen Daten.
      static java.util.ArrayList<de.elo.ix.client.ReportInfo> getReportList​(IXconnect ixConnect, de.elo.ix.client.FindReportInfo findInfo)
      Liefert eine Liste mit den Reporteinträgen für die angegebenen Suchkriterien zurück.
      static java.lang.String getReportMode​(IXconnect ixConnect)
      Liefert den Report Modus aus den Reportoptionen zurück.
      static java.io.File getSignatureFile​(IXconnect ixConnect, int objId, java.io.File targetDir)
      Lädt die Signaturdatei des Archivdokuments im angegebenen Verzeichnis.
      static java.util.List<de.elo.ix.client.SordLink> getSordLinks​(IXconnect ixConnect, int objId)
      Liefert alle ein- und ausgehende Links des angegebenen Archiveintrags.
      static java.util.ArrayList<de.elo.ix.client.Sord> getSubFolders​(IXconnect ixConnect, int folderId)
      Liefert eine Liste mit den Unterordnern des angegebenen Ordners zurück.
      static boolean hasAttachment​(IXconnect ixConnect, int objId)
      Meldet zurück, ob der angegebene Archiveintrag eine Dateianbindung enthält.
      static boolean hasFulltext​(IXconnect ixConnect, int objId)
      Meldet zurück, ob der angegebene Eintrag einen Volltextinhalt hat.
      static boolean hasSignature​(IXconnect ixConnect, int objId)
      Meldet zurück, ob der angegebene Archiveintrag eine Signatur hat.
      static int insertIntoArchive​(IXconnect ixConnect, java.io.File file, int targetId, java.lang.String maskName, java.lang.String version, java.lang.String versionComment, boolean isMilestone)
      Archiviert die Datei im angegebenen Archivordner.
      static void insertSignature​(IXconnect ixConnect, int objId, java.io.File sigFile)
      Fügt die angegebene Datei als Signatur ein.
      static boolean isImageFile​(java.io.File file)
      Meldet zurück, ob die angegebene Datei ein Bild ist.
      static boolean isValidGuid​(java.lang.String guid)
      Meldet zurück, ob die angegebene GUID ein gültiges Format besitzt.
      static void linkEntries​(IXconnect ixConnect, int sourceObjId, int destObjId)
      Verlinkt die Source Objekt ID mit der Ziel Objekt ID.
      static void loadFileFromFtp​(com.jcraft.jsch.Session session, java.io.File outputFile, java.lang.String remoteDir, boolean delSourceFile)
      Lädt eine Datei von einem SFTP-Server im angegeben File-Objekt herunter.
      static void removeAttachments​(IXconnect ixConnect, int objId)
      Entfernt die Dateianbindung des angegebenen Archivdokuments.
      static void saveChecksumReport​(ChecksumReport checksumReport)
      Speichert den angegebenen Report in der eingetragenen Reportdatei.
      static void saveDocumentVersion​(IXconnect ixConnect, java.io.File file, int objId, java.lang.String version, java.lang.String versionComment, boolean isMilestone)
      Speichert die angegebene Datei als eine neue Version an dem Archivdokument.
      static void saveReport​(IXconnect ixConnect, int userId, int objId, int actionNr, java.lang.String startDate, java.lang.String endDate, int maxReportCount, java.io.File targetFile)
      Speichert die Reportdaten in der angegebenen Datei.
      static void sendHttpGetRequest​(java.lang.String url, java.io.File responseFile)
      Sendet eine HttpGet-Anfrage an der angegebenen URL.
      static void sendHttpPostRequest​(java.lang.String url, byte[] source)
      Sendet eine HTTP Post-Anfrage an der angegebenen URL.
      static void sendHttpPostRequest​(java.lang.String url, java.io.File sourceFile)
      Versendet eine HttpPost-Anfrage an der angegebenen URL.
      static void startProcess​(java.lang.String[] arguments)
      Startet das angegebene externe Programm.
      static void uploadFileToFtp​(com.jcraft.jsch.Session session, java.io.File sourceFile, java.lang.String targetFilePath)
      Lädt die lokale Datei auf dem angegebenen Pfad auf dem FTP-Server hoch.
      static void writeBarcode​(IXconnect ixConnect, java.io.File targetFile, java.lang.String barcodeText, int width, int height, java.lang.String barcodeConfig)
      Schreibt die Barcodeinformationen in der angegebenen Datei.
      static void writeBarcode​(IXconnect ixConnect, java.io.File targetFile, java.lang.String barcodeText, java.lang.String barcodeFormat, int width, int height, int xPos, int yPos, java.lang.String barcodeConfig)
      Schreibt die Barcodeinformationen in der angegebenen Datei.
      static void writeBarcode​(IXconnect ixConnect, java.io.File targetFile, java.lang.String barcodeText, java.lang.String barcodeFormat, int width, int height, java.lang.String barcodeConfig)
      Schreibt die Barcodeinformationen in der angegebenen Datei.
      static void writeReportInfos​(java.util.ArrayList<de.elo.ix.client.ReportInfo> reportInfos, int actionNr, int maxReportCount, java.io.File targetFile)
      Schreibt die Reportdaten in der angegebenen Datei.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ELOAsUtils

        public ELOAsUtils()

    • Method Detail

      • findDoublet

        public static de.elo.ix.client.EditInfo findDoublet​(IXconnect ixConnect,
                                                    java.io.File file)
                                             throws java.lang.Exception
        Liefert die Verschlagwortungsinformationen der angegebenen Datei zurück.
        Parameters:
        ixConnect - Verbindung zum Index Server
        file - Zu archivierende Datei
        Returns:
        EditInfo des bereits abgelegten Archivdokuments oder null
        Throws:
        java.lang.Exception

      • createMd5

        public static java.lang.String createMd5​(java.io.File file)
                                  throws java.lang.Exception
        Emittelt den MD5-Hash der angegebenen Datei.
        Parameters:
        file - Datei
        Returns:
        MD5-Hash
        Throws:
        java.io.IOException
        java.lang.Exception

      • getBarcode

        public static java.lang.String getBarcode​(IXconnect ixConnect,
                                          java.io.File file,
                                          int page,
                                          java.lang.String barcodeConfig)
                                   throws java.lang.Exception
        Liefert die Barcode-Informationen für die angegebene Datei zurück.
        Parameters:
        ixConnect - Verbindung zum Index Server
        file - Datei
        page - Seite, aus der die Barcode-Information ausgelesen wird
        barcodeConfig - Barcode-Konfiguration
        Returns:
        Barcodeinformationen
        Throws:
        java.lang.Exception

      • getBarcodeResult

        public static com.google.zxing.Result getBarcodeResult​(IXconnect ixConnect,
                                                       java.io.File file,
                                                       int page,
                                                       java.lang.String barcodeConfig)
                                                throws java.lang.Exception
        Liefert die Barcode-Informationen für die angegebene Datei zurück.
        Parameters:
        ixConnect - Verbindung zum Index Server
        file - Datei
        page - Seite, aus der die Barcode-Information ausgelesen wird
        barcodeConfig - Barcode-Konfiguration
        Returns:
        Barcodeinformationen
        Throws:
        java.lang.Exception

      • writeBarcode

        public static void writeBarcode​(IXconnect ixConnect,
                                java.io.File targetFile,
                                java.lang.String barcodeText,
                                int width,
                                int height,
                                java.lang.String barcodeConfig)
                         throws java.lang.Exception
        Schreibt die Barcodeinformationen in der angegebenen Datei.
        Parameters:
        ixConnect - Verbindung zum IndexServer
        targetFile - Datei, in der die Barcodeinformationen geschrieben werden
        barcodeText - Text, der als Barcode geschrieben wird
        width - Barcode-Breite
        height - Barcode-Höhe
        barcodeConfig - Barcode-Konfiguration
        Throws:
        java.lang.Exception

      • writeBarcode

        public static void writeBarcode​(IXconnect ixConnect,
                                java.io.File targetFile,
                                java.lang.String barcodeText,
                                java.lang.String barcodeFormat,
                                int width,
                                int height,
                                java.lang.String barcodeConfig)
                         throws java.lang.Exception
        Schreibt die Barcodeinformationen in der angegebenen Datei.
        Parameters:
        ixConnect - Verbindung zum IndexServer
        targetFile - Datei, in der die Barcodeinformationen geschrieben werden
        barcodeText - Text, der als Barcode geschrieben wird
        barcodeFormat - Barcode-Format
        width - Barcode-Breite
        height - Barcode-Höhe
        barcodeConfig - Barcode-Konfiguration
        Throws:
        java.lang.Exception

      • writeBarcode

        public static void writeBarcode​(IXconnect ixConnect,
                                java.io.File targetFile,
                                java.lang.String barcodeText,
                                java.lang.String barcodeFormat,
                                int width,
                                int height,
                                int xPos,
                                int yPos,
                                java.lang.String barcodeConfig)
                         throws java.lang.Exception
        Schreibt die Barcodeinformationen in der angegebenen Datei.
        Parameters:
        ixConnect - Verbindung zum IndexServer
        targetFile - Datei, in der die Barcodeinformationen geschrieben werden
        barcodeText - Text, der als Barcode geschrieben wird
        barcodeFormat - Barcode-Format
        width - Barcode-Breite
        height - Barcode-Höhe
        xPos - Horizontale Barcode-Position
        yPos - Vertikale Barcode-Position
        barcodeConfig - Barcode-Konfiguration
        Throws:
        java.lang.Exception

      • createBarcodeReader

        public static BarcodeReader createBarcodeReader​(java.lang.String barcodeRulesDescr)
                                         throws java.lang.Exception
        Erzeugt ein Objekt für die Barcode-Erkennung.
        Parameters:
        barcodeRulesDescr - Definition der Barcode-Regeln
        Returns:
        Barcode-Reader
        Throws:
        java.lang.Exception

      • createBarcodeReader

        public static BarcodeReader createBarcodeReader()
                                         throws java.lang.Exception
        Erzeugt ein Objekt für die Barcode-Erkennung.
        Returns:
        Barcode-Reader
        Throws:
        java.lang.Exception

      • createBarcodeReader2

        public static BarcodeReader createBarcodeReader2​(IXconnect currIxConnect)
                                          throws java.lang.Exception
        Erzeugt ein Objekt für die Barcode-Erkennung.
        Parameters:
        currIxConnect - Index Server Verbindung
        Returns:
        Barcode-Reader
        Throws:
        java.lang.Exception

      • isImageFile

        public static boolean isImageFile​(java.io.File file)
                           throws java.lang.Exception
        Meldet zurück, ob die angegebene Datei ein Bild ist.
        Parameters:
        file - Datei
        Returns:
        Datei ist ein Bild
        Throws:
        java.lang.Exception

      • startProcess

        public static void startProcess​(java.lang.String[] arguments)
                         throws java.lang.Exception
        Startet das angegebene externe Programm.
        Parameters:
        arguments - Programmargumente
        Throws:
        java.lang.Exception

      • getOcrRect

        public static java.lang.String getOcrRect​(IXconnect ixConnect,
                                          int objId,
                                          java.lang.String[] langs,
                                          int pageNr,
                                          int top,
                                          int left,
                                          int bottom,
                                          int right)
                                   throws byps.RemoteException,
                                          java.lang.Exception
        Liefert den durch die OCR erkannten Text vom angegebenen Rechteck zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ObjektId des Archiveintrags
        langs - Liste mit OCR-Sprachen
        pageNr - Seitennummer (Anfang bei 0)
        top - Obere Grenze des OCR-Rechtecks
        left - Linke Grenze des OCR-Rechtecks
        bottom - Untere Grenze des OCR-Rechtecks
        right - Rechte Grenze des OCR-Rechtecks
        Returns:
        OCR-Text
        Throws:
        byps.RemoteException
        java.lang.Exception

      • getOcrText

        public static java.lang.String getOcrText​(IXconnect ixConnect,
                                          int objId,
                                          java.lang.String[] langs)
                                   throws byps.RemoteException,
                                          java.lang.Exception
        Liefert den kompletten OCR-Text für das angegebene Archivdokument zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ObjektId des Archiveintrags
        langs - Liste mit OCR-Sprachen
        Returns:
        Kompletter OCR-Text
        Throws:
        byps.RemoteException
        java.lang.Exception

      • getOcrTextForPage

        public static java.lang.String getOcrTextForPage​(IXconnect ixConnect,
                                                 java.lang.String objId,
                                                 int pageNr,
                                                 java.lang.String[] langs)
                                          throws java.lang.Exception
        Liefert den OCR-Text aus der angegebenen Dokumentseite zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archivdokuments
        pageNr - Seite des Archivdokuments
        langs - Liste mit OCR-Sprachen
        Returns:
        OCR-Text der Dokumentseite
        Throws:
        java.lang.Exception

      • checkOcrAvail

        public static boolean checkOcrAvail​(IXconnect ixConnect)
                             throws java.lang.Exception
        Meldet zurück, ob die OCR verfügbar ist.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        OCR verfügbar
        Throws:
        java.lang.Exception

      • getExternalOcrLanguages

        public static java.lang.String[] getExternalOcrLanguages​(IXconnect ixConnect)
                                                  throws java.lang.Exception
        Liefert die vorhandenen externen OCR-Sprachen zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Liste mit den OCR-Sprachen
        Throws:
        java.lang.Exception

      • getInternalOcrLanguages

        public static java.lang.String[] getInternalOcrLanguages​(IXconnect ixConnect)
                                                  throws java.lang.Exception
        Liefert die vorhandenen internen OCR-Sprachen zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Liste mit den OCR-Sprachen
        Throws:
        java.lang.Exception

      • sendHttpGetRequest

        public static void sendHttpGetRequest​(java.lang.String url,
                                      java.io.File responseFile)
                               throws java.io.IOException,
                                      java.lang.Exception
        Sendet eine HttpGet-Anfrage an der angegebenen URL.
        Parameters:
        url - URL, an die die Anfrage gesendet wird
        responseFile - Datei mit dem Anfrageergebnis
        Throws:
        java.io.IOException
        java.lang.Exception

      • sendHttpPostRequest

        public static void sendHttpPostRequest​(java.lang.String url,
                                       java.io.File sourceFile)
                                throws java.lang.Exception
        Versendet eine HttpPost-Anfrage an der angegebenen URL.
        Parameters:
        url - URL, an die die Anfrage gesendet wird
        sourceFile - Datei mit den Daten, die versendet werden
        Throws:
        java.lang.Exception

      • sendHttpPostRequest

        public static void sendHttpPostRequest​(java.lang.String url,
                                       byte[] source)
                                throws java.lang.Exception
        Sendet eine HTTP Post-Anfrage an der angegebenen URL.
        Parameters:
        url - URL, an die die Anfrage gesendet wird
        source - byte-Array mit den Daten für die Anfrage
        Throws:
        java.lang.Exception

      • getDocumentVersion

        public static java.io.File getDocumentVersion​(IXconnect ixConnect,
                                              int objId,
                                              java.io.File targetDir)
                                       throws java.lang.Exception
        Liefert die Arbeitsversion des angegebenen Archivdokuments zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archivdokuments
        targetDir - Verzeichnis, in dem die Arbeitsversion heruntergelanden wird
        Returns:
        Arbeitsversion
        Throws:
        java.lang.Exception

      • getDocumentVersionPart

        public static void getDocumentVersionPart​(IXconnect ixConnect,
                                          int objId,
                                          java.io.File targetFile,
                                          long offset,
                                          long length)
                                   throws java.lang.Exception
        Lädt den angegebene Teil der Arbeitsversion herunter.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archivdokuments
        targetFile - Zieldatei
        offset - Versatz
        length - Länge der zu lesenden Daten
        Throws:
        java.lang.Exception

      • getAttachmentVersion

        public static java.io.File getAttachmentVersion​(IXconnect ixConnect,
                                                int objId,
                                                java.io.File targetDir)
                                         throws java.lang.Exception
        Liefert die Arbeitsversion der Dateianbindung des angegebenen Archivdokuments zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archivdokuments
        targetDir - Verzeichnis, in dem die Arbeitsversion heruntergelanden wird
        Returns:
        Arbeitsversion
        Throws:
        java.lang.Exception

      • removeAttachments

        public static void removeAttachments​(IXconnect ixConnect,
                                     int objId)
                              throws java.lang.Exception
        Entfernt die Dateianbindung des angegebenen Archivdokuments.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archivdokuments
        Throws:
        java.lang.Exception

      • addAttachment

        public static void addAttachment​(IXconnect ixConnect,
                                 int objId,
                                 java.io.File sourceFile)
                          throws java.lang.Exception
        Fügt eine Dateianbindung an das angegebene Archivelement.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Dokuments, zu dem die Dateianbindung eingefügt wird
        sourceFile - Dateianbindung
        Throws:
        java.lang.Exception

      • saveDocumentVersion

        public static void saveDocumentVersion​(IXconnect ixConnect,
                                       java.io.File file,
                                       int objId,
                                       java.lang.String version,
                                       java.lang.String versionComment,
                                       boolean isMilestone)
                                throws java.lang.Exception
        Speichert die angegebene Datei als eine neue Version an dem Archivdokument.
        Parameters:
        ixConnect - Index Server Verbindung
        file - Datei, die als neue Version
        objId - Id des Archivdokuments
        version - Versionsbezeichnung
        versionComment - Versionskommentar
        isMilestone - Meilensteinversion
        Throws:
        java.lang.Exception

      • insertIntoArchive

        public static int insertIntoArchive​(IXconnect ixConnect,
                                    java.io.File file,
                                    int targetId,
                                    java.lang.String maskName,
                                    java.lang.String version,
                                    java.lang.String versionComment,
                                    boolean isMilestone)
                             throws java.lang.Exception
        Archiviert die Datei im angegebenen Archivordner.
        Parameters:
        ixConnect - Index Server Verbindung
        file - Datei, die archiviert wird
        targetId - Zielordner
        maskName - Verschlagwortungsmaske
        version - Versionsbezeichnung
        versionComment - Versionskommentar
        isMilestone - Meilensteinversion
        Returns:
        Id des Archivdokuments
        Throws:
        java.lang.Exception

      • createDefaultEditInfo

        public static de.elo.ix.client.EditInfo createDefaultEditInfo​(IXconnect ixConnect,
                                                              java.io.File file,
                                                              java.lang.String maskName,
                                                              int targetId)
                                                       throws byps.RemoteException,
                                                              java.lang.Exception
        Erzeugt eine Default-Verschlagwortung für die angegebene Datei.
        Parameters:
        ixConnect - Index Server Verbindung
        file - Zu archivierende Datei
        maskName - Maskennamen
        targetId - Id des Ablageordners
        Returns:
        Default-Verschlagwortung
        Throws:
        byps.RemoteException
        java.lang.Exception

      • addNewFolder

        public static int addNewFolder​(IXconnect ixConnect,
                               java.lang.String folderName,
                               int parentId,
                               java.lang.String maskName)
                        throws byps.RemoteException,
                               java.lang.Exception
        Erzeugt einen neuen Ordner im angegebenen Archivordner.
        Parameters:
        ixConnect - Index Server Verbindung
        folderName - Ordnername
        parentId - Id des Ordners, in dem der neue Ordner angelegt wird
        maskName - Maskennamen oder null für die Default-Ordnermaske
        Returns:
        Id des neuen Ordners
        Throws:
        byps.RemoteException
        java.lang.Exception

      • addDynamicFolder

        public static int addDynamicFolder​(IXconnect ixConnect,
                                   java.lang.String folderName,
                                   int parentId,
                                   java.lang.String maskName,
                                   java.lang.String descr)
                            throws java.lang.Exception
        Erstellt einen dynamischen Register im angegebenen Ordner.
        Parameters:
        ixConnect - Index Server Verbindung
        folderName - Name des dynamischen Ordners
        parentId - ParentId des dynamischen Ordners
        maskName - Maske des dynamischen Ordners
        descr - Zusatztext/Definition der Datenbankabfrage
        Returns:
        ID des neuen Ordners
        Throws:
        java.lang.Exception

      • exportArchiveDocuments

        public static void exportArchiveDocuments​(IXconnect ixConnect,
                                          int[] ids,
                                          java.io.File target,
                                          boolean zipFiles)
                                   throws java.lang.Exception
        Speichert die angegebenen Archivdokumente in einer ZIP-Datei oder in einem Ordner.
        Parameters:
        ixConnect - Index Server Verbindung
        ids - ObjektIds der Archivdokumente
        target - ZIP-Datei oder Zielordner
        zipFiles - Archivdokumente zippen
        Throws:
        java.lang.Exception

      • exportArchiveDocuments

        public static void exportArchiveDocuments​(IXconnect ixConnect,
                                          de.elo.ix.client.Sord[] sords,
                                          java.io.File target,
                                          boolean zipFiles,
                                          boolean useShortName)
                                   throws java.lang.Exception
        Speichert die angegebenen Archivdokumente in einer ZIP-Datei oder in einem Ordner.
        Parameters:
        ixConnect - Index Server Verbindung
        sords - Liste mit Archiveinträgen
        target - ZIP-Datei oder Zielordner
        zipFiles - Archivdokumente zippen
        useShortName - Kurzbezeichnung als Dateiname verwenden
        Throws:
        java.lang.Exception

      • getElementPath

        public static java.lang.String getElementPath​(IXconnect ixConnect,
                                              int objId)
                                       throws java.lang.Exception
        Liefert einen String mit dem Pfad zum angegebenen Archiveintrag zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archiveintrags
        Returns:
        Pfad zum Archiveintrag
        Throws:
        java.lang.Exception

      • getElementPath

        public static java.lang.String getElementPath​(IXconnect ixConnect,
                                              java.lang.String guid)
                                       throws java.lang.Exception
        Liefert einen String mit dem Pfad zum angegebenen Archiveintrag zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        guid - GUID des Archiveintrags
        Returns:
        Pfad zum Archiveintrag
        Throws:
        java.lang.Exception

      • getReferencePaths

        public static java.lang.String[] getReferencePaths​(IXconnect ixConnect,
                                                   int objId)
                                            throws java.lang.Exception
        Liefert eine Liste mit den Referenzpfaden des angegebenen Archiveintrags zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archiveintrags
        Returns:
        Liste mit den Referenzpfaden
        Throws:
        java.lang.Exception

      • fixElementPath

        public static java.lang.String fixElementPath​(java.lang.String path,
                                              de.elo.ix.client.Sord sord)
                                       throws java.lang.Exception
        Liefert einen vollständigen Archivpfad aus dem angegebenen Archivpfad und der Archiveintragsbezeichnung zurück.
        Parameters:
        path - Archivpfad
        sord - Verschlagwortung des Archiveintrags
        Returns:
        reparierten Archivpfad
        Throws:
        java.lang.Exception

      • getParentNames

        public static java.lang.String[] getParentNames​(IXconnect ixConnect,
                                                int objId)
                                         throws java.lang.Exception
        Liefert eine Liste mit den Namen der übergeordneten Archiveinträgen zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archivelements, dessen Pfad ausgelesen wird
        Returns:
        Liste mit Parentnamen
        Throws:
        java.lang.Exception

      • getJREString

        public static java.lang.String getJREString()
        Liefert Informationen zur Java Runtime Umgebung als formatierten String zurück.
        Returns:
        Informationen zur Java Runtime

      • getDefaultLang

        public static java.lang.String getDefaultLang()
        Liefert die Default-Sprache zurück.
        Returns:
        Default-Sprache

      • getAsVersion

        public static java.lang.String getAsVersion()
        Liefert die aktuelle AS-Version zurück.
        Returns:
        Aktuelle AS-Version

      • archivePathIsValid

        public static boolean archivePathIsValid​(java.lang.String archivePath)
                                  throws java.lang.Exception
        Meldet zurück, ob der angegebene Pfad gültig ist (kein leerer String).
        Parameters:
        archivePath - Archivpfad
        Returns:
        Pfad ist gültig
        Throws:
        java.lang.Exception

      • archivePathExists

        public static boolean archivePathExists​(IXconnect ixConnect,
                                        java.lang.String archivePath)
                                 throws java.lang.Exception
        Meldet zurück, ob der angegebene Archivpfad existiert.
        Parameters:
        ixConnect - Index Server Verbindung
        archivePath - Archivpfad
        Returns:
        Archivpfad existiert
        Throws:
        java.lang.Exception

      • createArcPath

        public static int createArcPath​(IXconnect ixConnect,
                                int parentId,
                                java.lang.String path)
                         throws java.lang.Exception
        Legt den angegebenen Archivpfad an.
        Parameters:
        ixConnect - Index Server Verbindung
        parentId - Parent ID
        path - Archivpfad als String
        Returns:
        ID des letzten Pfadeintrags
        Throws:
        java.lang.Exception

      • createStorePath

        public static de.elo.ix.client.StoreInfo createStorePath​(IXconnect ixConnect,
                                                         java.lang.String storeName,
                                                         java.lang.String directory)
                                                  throws java.lang.Exception
        Legt den angegebenen Speicherpfad an, falls dieser nicht vorhanden ist.
        Parameters:
        ixConnect - Index Server Verbindung
        storeName - Name des Speicherpfades
        directory - Verzeichnis des Speicherpfades
        Returns:
        Informationen zum Speicherpfad
        Throws:
        java.lang.Exception

      • getObjIdFromPath

        public static int getObjIdFromPath​(IXconnect ixConnect,
                                   java.lang.String archivePath)
                            throws java.lang.Exception
        Liefert die ID des Archiveintrags für den angegebenen Pfad zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        archivePath - Archivpfad
        Returns:
        ObjektId
        Throws:
        java.lang.Exception

      • getElemByArcpath

        public static de.elo.ix.client.Sord getElemByArcpath​(IXconnect ixConnect,
                                                     java.lang.String arcPath)
                                              throws java.lang.Exception
        Liefert den Archiveintrag mit dem angegebenen Archivpfad zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        arcPath - Archivpfad
        Returns:
        Archiveintrag oder null
        Throws:
        java.lang.Exception

      • getElemByArcpathRelative

        public static de.elo.ix.client.Sord getElemByArcpathRelative​(IXconnect ixConnect,
                                                             int rootId,
                                                             java.lang.String arcPath)
                                                      throws java.lang.Exception
        Liefert den Archiveintrag über einen Archivpfad relativ zu einem Startordner zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        rootId - ID des Startordners
        arcPath - Pfad relativ zum Startordner. Der Pfad besteht aus den Kurzbezeichnungen der Untereinträge mit beliebigem Trennzeichen. Der Pfad muss mit einem Trennzeichen beginnen.
        Returns:
        Archiveintrag
        Throws:
        java.lang.Exception - Fehler beim Lesen des Objektes vom Server

      • linkEntries

        public static void linkEntries​(IXconnect ixConnect,
                               int sourceObjId,
                               int destObjId)
                        throws java.lang.Exception
        Verlinkt die Source Objekt ID mit der Ziel Objekt ID.
        Parameters:
        ixConnect - Index Server Verbindung
        sourceObjId - ID des ersten Archiveintrags
        destObjId - ID des Zielarchiveintrags
        Throws:
        java.lang.Exception

      • getSordLinks

        public static java.util.List<de.elo.ix.client.SordLink> getSordLinks​(IXconnect ixConnect,
                                                                     int objId)
                                                              throws java.lang.Exception
        Liefert alle ein- und ausgehende Links des angegebenen Archiveintrags.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Id des Archiveintrags
        Returns:
        Liste mit den Links
        Throws:
        java.lang.Exception

      • getDocIdFromUploadResult

        public static int getDocIdFromUploadResult​(java.lang.String uploadResult)
                                    throws java.lang.Exception
        Liefert die neue EloDM-DokumentenId aus dem angegebenen UploadResult zurück.
        Parameters:
        uploadResult - Upload-Ergebnis
        Returns:
        Dokument-ID
        Throws:
        java.lang.Exception

      • loadFileFromFtp

        public static void loadFileFromFtp​(com.jcraft.jsch.Session session,
                                   java.io.File outputFile,
                                   java.lang.String remoteDir,
                                   boolean delSourceFile)
                            throws java.lang.Exception
        Lädt eine Datei von einem SFTP-Server im angegeben File-Objekt herunter.
        Parameters:
        session - Session-Objekt
        outputFile - Zieldatei
        remoteDir - Verzeichnis, von dem die Datei heruntergeladen wird
        delSourceFile - Datei auf dem FTP-Server löschen
        Throws:
        java.lang.Exception

      • uploadFileToFtp

        public static void uploadFileToFtp​(com.jcraft.jsch.Session session,
                                   java.io.File sourceFile,
                                   java.lang.String targetFilePath)
                            throws java.lang.Exception
        Lädt die lokale Datei auf dem angegebenen Pfad auf dem FTP-Server hoch.
        Parameters:
        session - Session Objekt
        sourceFile - Quelldatei
        targetFilePath - Pfad der Datei auf dem FTP-Server
        Throws:
        java.lang.Exception

      • createJschSession

        public static com.jcraft.jsch.Session createJschSession​(java.lang.String username,
                                                        java.lang.String password,
                                                        java.lang.String host,
                                                        int port)
                                                 throws com.jcraft.jsch.JSchException,
                                                        java.lang.Exception
        Erzeugt ein JSCH Session-Objekt, mit dem eine Verbindung aufgebaut wird.
        Parameters:
        username - Benutzername
        password - Benutzerpasswort
        host - Hostname
        port - Port für die Verbindung
        Returns:
        JSCH-Session
        Throws:
        com.jcraft.jsch.JSchException
        java.lang.Exception

      • getChecksumReport

        public static ChecksumReport getChecksumReport​(IXconnect ixConnect,
                                               de.elo.ix.client.Sord[] sords,
                                               java.io.File reportFile,
                                               boolean logOnlyErrors)
                                        throws java.lang.Exception
        Überprüft die Check-Summe der angegebenen Archiveinträge.
        Parameters:
        ixConnect - Index Server Verbindung
        sords - Liste mit den Verschlagwortungsobjekten
        reportFile - Reportdatei
        logOnlyErrors - Nur Fehler loggen
        Returns:
        Report-Ergebnis
        Throws:
        java.lang.Exception

      • saveChecksumReport

        public static void saveChecksumReport​(ChecksumReport checksumReport)
                               throws java.lang.Exception
        Speichert den angegebenen Report in der eingetragenen Reportdatei.
        Parameters:
        checksumReport - Checksummen-Report
        Throws:
        java.lang.Exception

      • checkEntryChecksum

        public static int checkEntryChecksum​(IXconnect ixConnect,
                                     de.elo.ix.client.Sord sord)
                              throws java.lang.Exception
        Überprüft die CheckSumme des angegebenen Archiveintrags. Wenn der Return Wert größer als 0 ist, dann ist das Dokument in Ordnung. 0 zeigt an, dass keine Dokumentendatei vorhanden ist und Werte kleiner als 0 zeigen ein fehlerhaftes Dokument an.
        Parameters:
        ixConnect - Index Server Verbindung
        sord - Verschlagwortung eines Archiveintrags
        Returns:
        1: ok, 0: no document, -6: cannot read result, -10: checkum error
        Throws:
        java.lang.Exception

      • checkEntryChecksumVersions

        public static int[] checkEntryChecksumVersions​(IXconnect ixConnect,
                                               de.elo.ix.client.Sord sord)
                                        throws java.lang.Exception
        Überprüft die CheckSumme von allen Versionen des angegebenen Archiveintrags. Wenn der Return Wert größer als 0 ist, dann ist das Dokument in Ordnung. 0 zeigt an, dass keine Dokumentendatei vorhanden ist und Werte kleiner als 0 zeigen ein fehlerhaftes Dokument an.
        Parameters:
        ixConnect - Index Server Verbindung
        sord - Verschlagwortung eines Archiveintrags
        Returns:
        Liste mit den Ergebnissen
        Throws:
        java.lang.Exception

      • getArchiveName

        public static java.lang.String getArchiveName​(IXconnect ixConnect)
                                       throws java.lang.Exception
        Liefert die Archivbezeichnung zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Archivbezeichnung
        Throws:
        java.lang.Exception

      • createExternalLinks

        public static java.util.ArrayList<de.elo.ix.client.PublicDownload> createExternalLinks​(IXconnect ixConnect,
                                                                                       int[] objIds,
                                                                                       int downloadCount,
                                                                                       java.lang.String expiredIsoDate,
                                                                                       boolean useShortName)
                                                                                throws java.lang.Exception
        Erstellt die externen Links für die angegebenen Dokumente und liefert diese zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objIds - Liste mit Objekt-Ids
        downloadCount - Maximale Anzahl der Downloads
        expiredIsoDate - Ablaufdatum der Dokument-URL
        useShortName - Kurzbezeichnung verwenden
        Returns:
        Liste mit Verschlagwortungsinformationen
        Throws:
        java.lang.Exception

      • getFulltextFile

        public static java.io.File getFulltextFile​(IXconnect ixConnect,
                                           int objId,
                                           java.io.File targetDir)
                                    throws java.lang.Exception
        Erstellt eine Datei mit dem Volltext-Inhalt des Archivdokuments im angegebenen Verzeichnis.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        targetDir - Zielverzeichnis
        Returns:
        Datei mit dem Volltextinhalt
        Throws:
        java.lang.Exception

      • getFulltextContent

        public static java.lang.String getFulltextContent​(IXconnect ixConnect,
                                                  int objId)
                                           throws java.lang.Exception
        Liefert den Volltext-Inhalt des angegebenen Archiveintrags zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        Returns:
        Volltext-Inhalt
        Throws:
        java.lang.Exception

      • insertSignature

        public static void insertSignature​(IXconnect ixConnect,
                                   int objId,
                                   java.io.File sigFile)
                            throws java.lang.Exception
        Fügt die angegebene Datei als Signatur ein.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        sigFile - Signaturdatei
        Throws:
        java.lang.Exception

      • getSignatureFile

        public static java.io.File getSignatureFile​(IXconnect ixConnect,
                                            int objId,
                                            java.io.File targetDir)
                                     throws java.lang.Exception
        Lädt die Signaturdatei des Archivdokuments im angegebenen Verzeichnis.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        targetDir - Zielverzeichnis
        Returns:
        Signaturdatei
        Throws:
        java.lang.Exception

      • hasAttachment

        public static boolean hasAttachment​(IXconnect ixConnect,
                                    int objId)
                             throws java.lang.Exception
        Meldet zurück, ob der angegebene Archiveintrag eine Dateianbindung enthält.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        Returns:
        Archiveintrag enthält eine Dateianbindung
        Throws:
        java.lang.Exception

      • hasSignature

        public static boolean hasSignature​(IXconnect ixConnect,
                                   int objId)
                            throws java.lang.Exception
        Meldet zurück, ob der angegebene Archiveintrag eine Signatur hat.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        Returns:
        Archiveintrag hat eine Signatur
        Throws:
        java.lang.Exception

      • hasFulltext

        public static boolean hasFulltext​(IXconnect ixConnect,
                                  int objId)
                           throws java.lang.Exception
        Meldet zurück, ob der angegebene Eintrag einen Volltextinhalt hat.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintragss
        Returns:
        Archiveintrag hat einen Volltextinhalt
        Throws:
        java.lang.Exception

      • getSubFolders

        public static java.util.ArrayList<de.elo.ix.client.Sord> getSubFolders​(IXconnect ixConnect,
                                                                       int folderId)
                                                                throws java.lang.Exception
        Liefert eine Liste mit den Unterordnern des angegebenen Ordners zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        folderId - Ordner ID
        Returns:
        Liste mit den Unterordnern
        Throws:
        java.lang.Exception

      • getFilingPaths

        public static de.elo.ix.client.IdName[] getFilingPaths​(IXconnect ixConnect)
                                                throws java.lang.Exception
        Liefert die vorhandenen Ablagepfade zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Liste mit Ablagepfaden
        Throws:
        java.lang.Exception

      • getDefaultPathId

        public static int getDefaultPathId​(IXconnect ixConnect)
                            throws java.lang.Exception
        Liefert den Default-Ablagepfad zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Default-Ablagepfad
        Throws:
        java.lang.Exception

      • getEditInfoFilingPaths

        public static de.elo.ix.client.EditInfo getEditInfoFilingPaths​(IXconnect ixConnect)
                                                        throws java.lang.Exception
        Liefert das EditInfo-Objekt mit den Ablagepfaden zurück.
        Parameters:
        ixConnect - Index Server Vebindung
        Returns:
        EditInfo mit den Ablagepfaden
        Throws:
        java.lang.Exception

      • getAsLibrariesNames

        public static java.util.ArrayList<java.lang.String> getAsLibrariesNames()
                                                                 throws java.lang.Exception
        Liefert eine Liste mit den Namen der vorhandenen AS-Libraries zurück.
        Returns:
        Liste mit Library-Namen
        Throws:
        java.lang.Exception

      • getPersonalFolder

        public static de.elo.ix.client.Sord getPersonalFolder​(IXconnect ixConnect,
                                                      int userId)
                                               throws java.lang.Exception
        Liefert die Verschlagwortung des Ordners "Persönlichen Bereich" zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        userId - Benutzer ID
        Returns:
        Ordner "Persönlicher Bereich"
        Throws:
        java.lang.Exception

      • addReportEntry

        public static void addReportEntry​(IXconnect ixConnect,
                                  int objId,
                                  int actionNo,
                                  int extra1,
                                  int extra2,
                                  java.lang.String message)
                           throws java.lang.Exception
        Schreibt einen Report Eintrag in die Datenbank. Der Parameter "actionNo" muss im Bereich von 3000 bis 3999 liegen.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ELO Objekt zu dem der Reporteintrag geschrieben werden soll
        actionNo - Aktionsnummer, Anwenderdefiniert, 3000...3999
        extra1 - Datenbankfeld extra1
        extra2 - Datenbankfeld extra2
        message - Kommentarfeld
        Throws:
        java.lang.Exception - Wenn der Reporteintrag nicht angelegt werden kann

      • getReportInfo

        public static de.elo.ix.client.ReportInfo getReportInfo​(IXconnect ixConnect,
                                                        int objId,
                                                        int userId,
                                                        int actionNo,
                                                        java.lang.String comment,
                                                        int extra1,
                                                        int extra2,
                                                        java.lang.String extraInfo)
                                                 throws java.lang.Exception
        Erzeugt ein ReportInfo Objekt aus den angegebenen Daten.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archiveintrags
        userId - Benutzer ID
        actionNo - Aktion Nummer
        comment - Kommentar der Aktion
        extra1 - Erstes Feld
        extra2 - Zweites Feld
        extraInfo - Zusätzliche Information
        Returns:
        ReportInfo Objekt
        Throws:
        java.lang.Exception

      • saveReport

        public static void saveReport​(IXconnect ixConnect,
                              int userId,
                              int objId,
                              int actionNr,
                              java.lang.String startDate,
                              java.lang.String endDate,
                              int maxReportCount,
                              java.io.File targetFile)
                       throws java.lang.Exception
        Speichert die Reportdaten in der angegebenen Datei.
        Parameters:
        ixConnect - Index Server Verbindung
        userId - Benutzer ID
        objId - ID des Archiveintrags
        actionNr - Aktionsnummer oder -1 für alle Reporteinträge
        startDate - Startdatum oder null für keine Einschränkung
        endDate - Enddatum oder null für keine Einschränkung
        maxReportCount - Maximale Anzahl an Reporteinträgen
        targetFile - Textdatei, in der der Report geschrieben wird
        Throws:
        java.lang.Exception

      • writeReportInfos

        public static void writeReportInfos​(java.util.ArrayList<de.elo.ix.client.ReportInfo> reportInfos,
                                    int actionNr,
                                    int maxReportCount,
                                    java.io.File targetFile)
                             throws java.lang.Exception
        Schreibt die Reportdaten in der angegebenen Datei.
        Parameters:
        reportInfos - Liste mit Reportdaten
        actionNr - Aktion ID oder -1 für alle Reporteinträge
        maxReportCount - Maximale Anzahl an Reporteinträgen
        targetFile - Zieldatei
        Throws:
        java.lang.Exception

      • getReportList

        public static java.util.ArrayList<de.elo.ix.client.ReportInfo> getReportList​(IXconnect ixConnect,
                                                                             de.elo.ix.client.FindReportInfo findInfo)
                                                                      throws java.lang.Exception
        Liefert eine Liste mit den Reporteinträgen für die angegebenen Suchkriterien zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        findInfo - Suchkriterien
        Returns:
        Liste mit Reporteinträgen
        Throws:
        java.lang.Exception

      • getReportMode

        public static java.lang.String getReportMode​(IXconnect ixConnect)
                                      throws java.lang.Exception
        Liefert den Report Modus aus den Reportoptionen zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        Report Modus
        Throws:
        java.lang.Exception

      • isValidGuid

        public static boolean isValidGuid​(java.lang.String guid)
                           throws java.lang.Exception
        Meldet zurück, ob die angegebene GUID ein gültiges Format besitzt.
        Parameters:
        guid - GUID
        Returns:
        GUID hat ein gültiges Format
        Throws:
        java.lang.Exception

      • getLastDocumentId

        public static int getLastDocumentId​(IXconnect ixConnect)
                             throws java.lang.Exception
        Liefert die letzte physikalische Dokumentennummer im Archiv zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        Returns:
        letzte physikalische Dokumentennummer
        Throws:
        java.lang.Exception