Package de.elo.mover.main.helper

Class DocVersionHelper

java.lang.Object

de.elo.mover.main.helper.DocVersionHelper

public class DocVersionHelper
extends Object

Überschrift: DocVersionHelper.

Beschreibung: Hilfsklasse für die Dokumentversionen.

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

Constructor Summary

Constructors

Constructor	Description
DocVersionHelper()

Method Summary

Modifier and Type	Method	Description
static void	deleteDocumentVersions(IXconnect ixConnect, int objId)	Löscht alle Dokumentversionen bis auf die Arbeitsversion des angegebenen Dokuments.
static String	docVersionToString(de.elo.ix.client.DocVersion docVersion)	Liefert die Beschreibung der angegebenen Dokumentversion zurück.
static 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, String md5, boolean inclDeleted)	Liefert die interne Dokumenten-ID zum angegebenen Treffer aus dem LookupHistMD5 zurück.
static int	getHistObj(IXconnect ixConnect, int index, String md5, boolean inclDeleted)	Liefert die Objekt Id zum angegebenen Treffer aus dem LookupHistMD5 zurück.
static ArrayList<de.elo.ix.client.DocVersion>	getMilestoneVersions(de.elo.ix.client.DocVersion[] docVersions)	Liefert die nicht löschbaren Versionen zurück.
static 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, String md5Value, boolean inclDeleted)	Liefert die Anzahl der Dokumentversionen mit dem angegebenen MD5-Wert zurück.
static String	getVersionWithoutPrefix(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 String	increaseVersion(String versionString)	Zählt die angegebene Dokumentenversion um eins hoch.
static boolean	isMilestone(String versionName)	Meldet zurück, ob die angegebene Versionsbezeichnung einer nicht löschbaren Version entspricht.
static void	setDocVersionProperties(IXconnect ixConnect, int objId, String versDesc, String versComment, boolean milestone)	Setzt die angegebenen Eigenschaften in der Arbeitsversion des angegebenen Dokuments.
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 Details

DocVersionHelper

public DocVersionHelper()

Method Details

isMilestone

public static boolean isMilestone(String versionName)
                           throws Exception

Meldet zurück, ob die angegebene Versionsbezeichnung einer nicht löschbaren Version entspricht.

Parameters:

versionName - Versionsbezeichnung

Returns:

True bei einer nicht löschbaren Version

Throws:

Exception

getVersionWithoutPrefix

public static String getVersionWithoutPrefix(String versionName)
                                      throws 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:

Exception

getWorkVersion

public static de.elo.ix.client.DocVersion getWorkVersion(de.elo.ix.client.DocVersion[] docVersions)
                                                  throws Exception

Liefert die Arbeitsversion aus den angegebenen Versionen zurück.

Parameters:

docVersions - Liste mit Dokumentversionen

Returns:

Throws:

Exception

getDeletedVersions

public static ArrayList<de.elo.ix.client.DocVersion> getDeletedVersions(de.elo.ix.client.DocVersion[] docVersions)
                                                                 throws Exception

Liefert die gelöschten Dokumentversionen zurück.

Parameters:

docVersions - Liste mit Dokumentversionen

Returns:

Liste mit gelöschten Dokumentversionen

Throws:

Exception

getNotDeletedVersions

public static ArrayList<de.elo.ix.client.DocVersion> getNotDeletedVersions(de.elo.ix.client.DocVersion[] docVersions)
                                                                    throws Exception

Liefert die normalen (nicht gelöschten) Dokumentversionen zurück.

Parameters:

docVersions - Liste mit Dokumentversionen

Returns:

Liste mit normalen Dokumentversionen

Throws:

Exception

getMilestoneVersions

public static ArrayList<de.elo.ix.client.DocVersion> getMilestoneVersions(de.elo.ix.client.DocVersion[] docVersions)
                                                                   throws Exception

Liefert die nicht löschbaren Versionen zurück.

Parameters:

docVersions - Liste mit Dokumentversionen

Returns:

Liste mit nicht löschbaren Versionen

Throws:

Exception

getVersionCountWithMd5

public static int getVersionCountWithMd5(IXconnect ixConnect,
 String md5Value,
 boolean inclDeleted)
                                  throws Exception

Liefert die Anzahl der Dokumentversionen mit dem angegebenen MD5-Wert zurück.

Parameters:

ixConnect - Indexserver-Verbindung

md5Value - MD5-Wert

inclDeleted - Gelöschte Versionen durchsuchen

Returns:

Anzahl der Dokumentversionen mit dem MD5 Wert

Throws:

Exception

docVersionToString

public static String docVersionToString(de.elo.ix.client.DocVersion docVersion)
                                 throws Exception

Liefert die Beschreibung der angegebenen Dokumentversion zurück.

Parameters:

docVersion - Dokumentversion

Returns:

Beschreibung der Version

Throws:

Exception

increaseVersion

public static String increaseVersion(String versionString)
                              throws Exception

Zählt die angegebene Dokumentenversion um eins hoch.

Parameters:

versionString - Versionsbeschreibung

Returns:

String Um eins erhöhte Versionsbeschreibung

Throws:

Exception

setWorkVersion

public static void setWorkVersion(IXconnect ixConnect,
 int objId,
 int workVersionId)
                           throws Exception

Setzt die angegebene neue Arbeitsversion.

Parameters:

ixConnect - Indexserver-Verbindung

objId - ID des Dokuments

workVersionId - ID der Arbeitsversion

Throws:

Exception

getHistDoc

public static int getHistDoc(IXconnect ixConnect,
 int index,
 String md5,
 boolean inclDeleted)
                      throws Exception

Liefert die interne Dokumenten-ID zum angegebenen Treffer aus dem LookupHistMD5 zurück.

Parameters:

ixConnect - Indexserver-Verbindung

index - Index des Suchtreffers

md5 - MD5-Wert

inclDeleted - Inklusive gelöschte Einträge

Returns:

Dokumenten-ID oder -1 bei einem Fehler

Throws:

Exception

getHistObj

public static int getHistObj(IXconnect ixConnect,
 int index,
 String md5,
 boolean inclDeleted)
                      throws Exception

Liefert die Objekt Id zum angegebenen Treffer aus dem LookupHistMD5 zurück.

Parameters:

ixConnect - Indexserver-Verbindung

index - Index des Suchtreffers

md5 - MD5-Wert

inclDeleted - Inklusive gelöschte Einträge

Returns:

Dokumenten-ID oder -1 bei einem Fehler

Throws:

Exception

setDocVersionProperties

public static void setDocVersionProperties(IXconnect ixConnect,
 int objId,
 String versDesc,
 String versComment,
 boolean milestone)
                                    throws Exception

Setzt die angegebenen Eigenschaften in der Arbeitsversion des angegebenen Dokuments.

Parameters:

ixConnect - Indexserver-Verbindung

objId - Objekt-ID des Dokuments

versDesc - Versionsbezeichnung

versComment - Versionskommentar

milestone - Nicht löschbare Version

Throws:

Exception

deleteDocumentVersions

public static void deleteDocumentVersions(IXconnect ixConnect,
 int objId)
                                   throws Exception

Löscht alle Dokumentversionen bis auf die Arbeitsversion des angegebenen Dokuments.

Parameters:

ixConnect - Indexserver-Verbindung

objId - Objekt-ID des Dokuments

Throws:

Exception

getDocumentVersions

public static de.elo.ix.client.DocVersion[] getDocumentVersions(IXconnect ixConnect,
 int objId)
                                                         throws Exception

Liefert eine Liste mit den normalen (nicht gelöschten) Dokumentversionen zurück.

Parameters:

ixConnect - Indexserver-Verbindung

objId - ID des Dokuments

Returns:

Liste mit Dokumentversionen

Throws:

Exception