de.elo.client.scripting.interfaces
Class ArchiveAdapter

java.lang.Object
  de.elo.client.scripting.interfaces.ArchiveAdapter

public class ArchiveAdapter
extends java.lang.Object

Überschrift: ArchiveAdapter

Beschreibung: Kapselt das ELO-Archiv gegenüber dem Script. Im Scripting verfügbar als "archive".

Copyright: Copyright (c) ELO Digital Office GmbH 2007-2011

Constructor Summary

ArchiveAdapter(de.elo.client.maindialog.Workspace workspace)
Normaler Konstruktor.

Method Summary

java.lang.String	getArchiveName() Liefert den Archivnamen zurück.
java.util.List<de.elo.ix.client.DocMask>	getDocMasks(boolean includeDocMasks, boolean includeFolderMasks, boolean includeSearchMasks) Liefert eine Liste mit den Verschlagwortungsmasken zurück.
ArchiveElement	getElement(int id) Liefert das ArchivElement (ArchiveDocument oder StructureElement).
ArchiveElement	getElementByArcpath(java.lang.String arcpath) Liefert das ArchivElement (ArchiveDocument oder StructureElement).
ArchiveElement	getElementByArcpathRelative(int rootId, java.lang.String arcpath) Liefert das ArchivElement (ArchiveDocument oder StructureElement).
ArchiveElement	getElementByGuid(java.lang.String guid) Liefert das ArchivElement (Archive-Dokument oder Structure-Element).
java.io.File	getFile(de.elo.ix.client.Sord sord, de.elo.ix.client.DocVersion docVersion) Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.
java.lang.String	getGlobalOption(java.lang.String optionKey, java.lang.String defaultValue) Liest die angegebene Option aus dem globalen Profil.
java.util.List<de.elo.ix.client.UserName>	getUserNames(boolean includeUsers, boolean includeGroups) Liefert eine Liste mit allen Anwendern und/oder Anwendergruppen des Archivs.
java.lang.String	getUserOption(java.lang.String optionKey, java.lang.String defaultValue) Liest die angegebene Option aus dem Profil des aktuellen Anwenders.
int	lookupMaskId(java.lang.String maskName) Ermittelt die Masken-Nummer zu dem angegebenen Maskennamen.
int	lookupUserId(java.lang.String userName) Ermittelt die Anwender-Nummer zu dem angegebenen Anwendernamen.
void	setGlobalOption(java.lang.String optionKey, java.lang.String optionValue) Setzt die Option im globalen Profil.
void	setUserOption(java.lang.String optionKey, java.lang.String optionValue) Setzt die angegebene Option im Profil des aktuellen Anwenders.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveAdapter

public ArchiveAdapter(de.elo.client.maindialog.Workspace workspace)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

Method Detail

getElement

public ArchiveElement getElement(int id)

Liefert das ArchivElement (ArchiveDocument oder StructureElement).

Parameters:

id - ObjektId des Archivelements

Returns:

ArchiveElement (CheckoutDocument, ArchiveDocument oder StructureElement)

getElementByArcpath

public ArchiveElement getElementByArcpath(java.lang.String arcpath)
                                   throws java.rmi.RemoteException

Liefert das ArchivElement (ArchiveDocument oder StructureElement).

Parameters:

arcpath - Pfad(Kurzbezeichnungen) mit beliebigem Trennzeichen zum Element. Der Pfad beginnt mit einem Trennzeichen.

Returns:

ArchiveElement (CheckoutDocument, ArchiveDocument oder StructureElement)

Throws:

java.rmi.RemoteException

getElementByArcpathRelative

public ArchiveElement getElementByArcpathRelative(int rootId,
                                                  java.lang.String arcpath)
                                           throws java.rmi.RemoteException

Liefert das ArchivElement (ArchiveDocument oder StructureElement).

Parameters:

rootId - Startobjekt

arcpath - Pfad relativ zum Startobjekt(Kurzbezeichnungen) mit beliebigem Trennzeichen zum Element. Der Pfad beginnt mit einem Trennzeichen.

Returns:

ArchiveElement (CheckoutDocument, ArchiveDocument oder StructureElement)

Throws:

java.rmi.RemoteException

Since:

8.01.000

getElementByGuid

public ArchiveElement getElementByGuid(java.lang.String guid)
                                throws java.rmi.RemoteException

Liefert das ArchivElement (Archive-Dokument oder Structure-Element).

Parameters:

guid - Die global eindeutige ID des Archivelementes

Returns:

ArchiveElement (CheckoutDocument, ArchiveDocument oder StructureElement)

Throws:

java.rmi.RemoteException

getUserOption

public java.lang.String getUserOption(java.lang.String optionKey,
                                      java.lang.String defaultValue)
                               throws java.rmi.RemoteException

Liest die angegebene Option aus dem Profil des aktuellen Anwenders.

Parameters:

optionKey - Bezeichner der Option

defaultValue - Defaultwert welcher zurückgegeben wird, falls die Option nicht vorhanden ist

Returns:

String Wert der Option

Throws:

java.rmi.RemoteException

Since:

7.00.006

getGlobalOption

public java.lang.String getGlobalOption(java.lang.String optionKey,
                                        java.lang.String defaultValue)
                                 throws java.rmi.RemoteException

Liest die angegebene Option aus dem globalen Profil.

Parameters:

optionKey - Bezeichner der Option

defaultValue - Defaultwert welcher zurückgegeben wird, falls die Option nicht vorhanden ist.

Returns:

String Wert der Option

Throws:

java.rmi.RemoteException

Since:

7.00.006

setUserOption

public void setUserOption(java.lang.String optionKey,
                          java.lang.String optionValue)
                   throws java.rmi.RemoteException

Setzt die angegebene Option im Profil des aktuellen Anwenders.

Parameters:

optionKey - Bezeichner der Option

optionValue - Zu setzender Optionswert

Throws:

java.rmi.RemoteException

Since:

7.00.006

setGlobalOption

public void setGlobalOption(java.lang.String optionKey,
                            java.lang.String optionValue)
                     throws java.rmi.RemoteException

Setzt die Option im globalen Profil.

Parameters:

optionKey - Bezeichner der Option

optionValue - Zu setzender Optionswert

Throws:

java.rmi.RemoteException

Since:

7.00.006

getUserNames

public java.util.List<de.elo.ix.client.UserName> getUserNames(boolean includeUsers,
                                                              boolean includeGroups)

Liefert eine Liste mit allen Anwendern und/oder Anwendergruppen des Archivs.

Parameters:

includeUsers - Bei True werden die Anwender zurückgegeben

includeGroups - Bei True werden die Gruppen zurückgegeben

Returns:

Liste mit den Anwendern und/oder Anwendergruppen

Since:

7.00.008

getDocMasks

public java.util.List<de.elo.ix.client.DocMask> getDocMasks(boolean includeDocMasks,
                                                            boolean includeFolderMasks,
                                                            boolean includeSearchMasks)
                                                     throws java.rmi.RemoteException

Liefert eine Liste mit den Verschlagwortungsmasken zurück.

Parameters:

includeDocMasks - Dokumentenmasken zurückliefern

includeFolderMasks - Ordnermasken zurückliefern

includeSearchMasks - Suchmasken zurückliefern

Returns:

List

Throws:

java.rmi.RemoteException

Since:

8.00.000

getArchiveName

public java.lang.String getArchiveName()

Liefert den Archivnamen zurück.

Returns:

Archivnamen

Since:

8.00.000

getFile

public java.io.File getFile(de.elo.ix.client.Sord sord,
                            de.elo.ix.client.DocVersion docVersion)
                     throws java.security.InvalidKeyException,
                            de.elo.client.guiutil.exception.DecryptCanceledException,
                            java.io.IOException

Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.

Liefert die Dokumentdatei zu der übergebenen Dokumentversion. Falls die Version verschlüsselt ist, wird dem Anwender ein Dialog zu Eingabe des Kennworts angezeigt.

Parameters:

docVersion -

Returns:

Dokumentdatei im Cache-Verzeichnis

Throws:

java.security.InvalidKeyException

de.elo.client.guiutil.exception.DecryptCanceledException - Bei Abbruch der Kennworteingabe.

java.io.IOException

Since:

8.01.000

lookupMaskId

public int lookupMaskId(java.lang.String maskName)

Ermittelt die Masken-Nummer zu dem angegebenen Maskennamen.

Parameters:

maskName - gesuchte Maske

Returns:

Nummer der gesuchten Maske oder -1 falls die Maske nicht gefunden wurde

Since:

8.01.000

lookupUserId

public int lookupUserId(java.lang.String userName)

Ermittelt die Anwender-Nummer zu dem angegebenen Anwendernamen.

Parameters:

userName - gesuchter Anwender

Returns:

Nummer der gesuchten Anwender oder -1 falls der Anwender nicht gefunden wurde

Since:

8.01.000