Package de.elo.mover.main.helper

Class DocVersionHelper

  • public class DocVersionHelper
extends java.lang.Object

    Überschrift: DocVersionHelper.

    Beschreibung: Hilfsklasse für die Dokumentversionen.

    Copyright: Copyright (c) ELO Digital Office GmbH 2018

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void deleteDocumentVersions​(IXconnect ixConnect, int objId)
      Löscht alle Dokumentversionen bis auf die Arbeitsversion des angegebenen Archivdokuments.
      static java.lang.String docVersionToString​(de.elo.ix.client.DocVersion docVersion)
      Liefert die Beschreibung der angegebenen Dokumentversion zurück.
      static java.util.ArrayList<de.elo.ix.client.DocVersion> getDeletedVersions​(de.elo.ix.client.DocVersion[] docVersions)
      Liefert die gelöschten Dokumentversionen zurück.
      static de.elo.ix.client.DocVersion[] getDocumentVersions​(IXconnect ixConnect, int objId)
      Liefert eine Liste mit den normalen (nicht gelöschten) Dokumentversionen zurück.
      static int getHistDoc​(IXconnect ixConnect, int index, java.lang.String md5, boolean inclDeleted)
      Liefert die interne Dokumenten-ID zum angegebenen Treffer aus dem LookupHistMD5 zurück.
      static int getHistObj​(IXconnect ixConnect, int index, java.lang.String md5, boolean inclDeleted)
      Liefert die Objekt Id zum angegebenen Treffer aus dem LookupHistMD5 zurück.
      static java.util.ArrayList<de.elo.ix.client.DocVersion> getMilestoneVersions​(de.elo.ix.client.DocVersion[] docVersions)
      Liefert die Meilenstein-Versionen zurück.
      static java.util.ArrayList<de.elo.ix.client.DocVersion> getNotDeletedVersions​(de.elo.ix.client.DocVersion[] docVersions)
      Liefert die normalen (nicht gelöschten) Dokumentversionen zurück.
      static int getVersionCountWithMd5​(IXconnect ixConnect, java.lang.String md5Value, boolean inclDeleted)
      Liefert die Anzahl der Dokumentversionen mit dem angegebenen MD5-Wert zurück.
      static java.lang.String getVersionWithoutPrefix​(java.lang.String versionName)
      Liefert die Versionsnummer ohne Flags-Präfix zurück.
      static de.elo.ix.client.DocVersion getWorkVersion​(de.elo.ix.client.DocVersion[] docVersions)
      Liefert die Arbeitsversion aus den angegebenen Versionen zurück.
      static java.lang.String increaseVersion​(java.lang.String versionString)
      Zählt die angegebene Dokumentenversion um eins hoch.
      static boolean isMilestone​(java.lang.String versionName)
      Meldet zurück, ob die angegebene Versionsbezeichnung einer Meilenstein-Version entspricht.
      static void setDocVersionProperties​(IXconnect ixConnect, int objId, java.lang.String versDesc, java.lang.String versComment, boolean milestone)
      Setzt die angegebenen Eigenschaften in der Arbeitsversion des angegebenen Archivdokuments.
      static void setWorkVersion​(IXconnect ixConnect, int objId, int workVersionId)
      Setzt die angegebene neue Arbeitsversion.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DocVersionHelper

        public DocVersionHelper()

    • Method Detail

      • isMilestone

        public static boolean isMilestone​(java.lang.String versionName)
                           throws java.lang.Exception
        Meldet zurück, ob die angegebene Versionsbezeichnung einer Meilenstein-Version entspricht.
        Parameters:
        versionName - Versionsbezeichnung
        Returns:
        Bezeichnung einer Meilenstein-Version
        Throws:
        java.lang.Exception

      • getVersionWithoutPrefix

        public static java.lang.String getVersionWithoutPrefix​(java.lang.String versionName)
                                                throws java.lang.Exception
        Liefert die Versionsnummer ohne Flags-Präfix zurück. Aus "[[123]]1.0" wird z.B. "1.0".
        Parameters:
        versionName - Versionsbezeichnung
        Returns:
        Versionsnummer ohne Flags-Präfix
        Throws:
        java.lang.Exception

      • getWorkVersion

        public static de.elo.ix.client.DocVersion getWorkVersion​(de.elo.ix.client.DocVersion[] docVersions)
                                                  throws java.lang.Exception
        Liefert die Arbeitsversion aus den angegebenen Versionen zurück.
        Parameters:
        docVersions - Liste mit Dokumentversionen
        Returns:
        Throws:
        java.lang.Exception

      • getDeletedVersions

        public static java.util.ArrayList<de.elo.ix.client.DocVersion> getDeletedVersions​(de.elo.ix.client.DocVersion[] docVersions)
                                                                           throws java.lang.Exception
        Liefert die gelöschten Dokumentversionen zurück.
        Parameters:
        docVersions - Liste mit Dokumentversionen
        Returns:
        Liste mit gelöschten Dokumentversionen
        Throws:
        java.lang.Exception

      • getNotDeletedVersions

        public static java.util.ArrayList<de.elo.ix.client.DocVersion> getNotDeletedVersions​(de.elo.ix.client.DocVersion[] docVersions)
                                                                              throws java.lang.Exception
        Liefert die normalen (nicht gelöschten) Dokumentversionen zurück.
        Parameters:
        docVersions - Liste mit Dokumentversionen
        Returns:
        Liste mit normalen Dokumentversionen
        Throws:
        java.lang.Exception

      • getMilestoneVersions

        public static java.util.ArrayList<de.elo.ix.client.DocVersion> getMilestoneVersions​(de.elo.ix.client.DocVersion[] docVersions)
                                                                             throws java.lang.Exception
        Liefert die Meilenstein-Versionen zurück.
        Parameters:
        docVersions - Liste mit Dokumentversionen
        Returns:
        Liste mit Meilenstein-Versionen
        Throws:
        java.lang.Exception

      • getVersionCountWithMd5

        public static int getVersionCountWithMd5​(IXconnect ixConnect,
                                         java.lang.String md5Value,
                                         boolean inclDeleted)
                                  throws java.lang.Exception
        Liefert die Anzahl der Dokumentversionen mit dem angegebenen MD5-Wert zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        md5Value - MD5-Wert
        inclDeleted - Gelöschte Versionen durchsuchen
        Returns:
        Anzahl der Dokumentversionen mit dem MD5 Wert
        Throws:
        java.lang.Exception

      • docVersionToString

        public static java.lang.String docVersionToString​(de.elo.ix.client.DocVersion docVersion)
                                           throws java.lang.Exception
        Liefert die Beschreibung der angegebenen Dokumentversion zurück.
        Parameters:
        docVersion - Dokumentversion
        Returns:
        Beschreibung der Version
        Throws:
        java.lang.Exception

      • increaseVersion

        public static java.lang.String increaseVersion​(java.lang.String versionString)
                                        throws java.lang.Exception
        Zählt die angegebene Dokumentenversion um eins hoch.
        Parameters:
        versionString - Versionsbeschreibung
        Returns:
        String Um eins erhöhte Versionsbeschreibung
        Throws:
        java.lang.Exception

      • setWorkVersion

        public static void setWorkVersion​(IXconnect ixConnect,
                                  int objId,
                                  int workVersionId)
                           throws java.lang.Exception
        Setzt die angegebene neue Arbeitsversion.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archivdokuments
        workVersionId - ID der Arbeitsversion
        Throws:
        java.lang.Exception

      • getHistDoc

        public static int getHistDoc​(IXconnect ixConnect,
                             int index,
                             java.lang.String md5,
                             boolean inclDeleted)
                      throws java.lang.Exception
        Liefert die interne Dokumenten-ID zum angegebenen Treffer aus dem LookupHistMD5 zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        index - Index des Suchtreffers
        md5 - MD5-Wert
        inclDeleted - Inklusive gelöschte Einträge
        Returns:
        Dokumenten-ID oder -1 bei einem Fehler
        Throws:
        java.lang.Exception

      • getHistObj

        public static int getHistObj​(IXconnect ixConnect,
                             int index,
                             java.lang.String md5,
                             boolean inclDeleted)
                      throws java.lang.Exception
        Liefert die Objekt Id zum angegebenen Treffer aus dem LookupHistMD5 zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        index - Index des Suchtreffers
        md5 - MD5-Wert
        inclDeleted - Inklusive gelöschte Einträge
        Returns:
        Dokumenten-ID oder -1 bei einem Fehler
        Throws:
        java.lang.Exception

      • setDocVersionProperties

        public static void setDocVersionProperties​(IXconnect ixConnect,
                                           int objId,
                                           java.lang.String versDesc,
                                           java.lang.String versComment,
                                           boolean milestone)
                                    throws java.lang.Exception
        Setzt die angegebenen Eigenschaften in der Arbeitsversion des angegebenen Archivdokuments.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Objekt ID des Archivdokuments
        versDesc - Versionsbezeichnung
        versComment - Versionskommentar
        milestone - Meilenstein Version
        Throws:
        java.lang.Exception

      • deleteDocumentVersions

        public static void deleteDocumentVersions​(IXconnect ixConnect,
                                          int objId)
                                   throws java.lang.Exception
        Löscht alle Dokumentversionen bis auf die Arbeitsversion des angegebenen Archivdokuments.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - Objekt ID des Archivdokuments
        Throws:
        java.lang.Exception

      • getDocumentVersions

        public static de.elo.ix.client.DocVersion[] getDocumentVersions​(IXconnect ixConnect,
                                                                int objId)
                                                         throws java.lang.Exception
        Liefert eine Liste mit den normalen (nicht gelöschten) Dokumentversionen zurück.
        Parameters:
        ixConnect - Index Server Verbindung
        objId - ID des Archivdokuments
        Returns:
        Liste mit Dokumentversionen
        Throws:
        java.lang.Exception