Package de.elo.client.scripting.interfaces

Class ArchiveAdapter

  • public class ArchiveAdapter
extends 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-2016

    • Constructor Summary

      Constructors 
      Constructor Description
      ArchiveAdapter​(Workspace workspace)
      Interner Konstruktor.

    • Method Summary

      Modifier and Type Method Description
      File exportFiles​(File destDir, Enumeration<ArchiveElement> items)
      Kopiert die Dateien einer Liste von Archivdokumenten in ein Ausgabeverzeichnis.
      String getArchiveName()
      Liefert den Namen des aktuellen Archiv-Profils.
      DocMask getDocMask​(String maskIdOrName)
      Liefert die Verschlagwortungsmaske für die angegebenen MaskenID zurück.
      List<DocMask> getDocMasks​(boolean includeDocMasks, boolean includeFolderMasks, boolean includeSearchMasks)
      Liefert eine Liste mit den Verschlagwortungsmasken.
      ArchiveElement getElement​(int id)
      Liefert den Archiveintrag zu einer Objekt-ID.
      ArchiveElement getElementByArcpath​(String arcpath)
      Liefert den Archiveintrag zu einem Archivpfad.
      ArchiveElement getElementByArcpathRelative​(int rootId, String arcpath)
      Liefert den Archiveintrag über einen Archivpfad relativ zu einem Startordner.
      ArchiveElement getElementByGuid​(String guid)
      Liefert den Archiveintrag anhand seiner GUID oder ELO ObjId.
      File getFile​(Sord sord, DocVersion docVersion)
      Deprecated.
      UNDER CONSTRUCTION, do not use this function, it may change.
      String getGlobalOption​(String optionKey, String defaultValue)
      Liest die angegebene Option aus dem globalen Profil.
      String[] getReferencePaths​(EditInfo editInfo)
      Liefert eine Liste mit den Referenzpfaden des angegebenen Archiveintrags zurück.
      List<UserName> getUserNames​(boolean includeUsers, boolean includeGroups)
      Liefert eine Liste mit allen Anwendern und/oder Anwendergruppen des Archivs.
      String getUserOption​(String optionKey, String defaultValue)
      Liest die angegebene Option aus dem Profil des aktuellen Anwenders.
      int lookupMaskId​(String maskName)
      Ermittelt die Masken-Nummer zu dem angegebenen Maskennamen.
      int lookupUserId​(String userName)
      Ermittelt die Anwender-Nummer zu dem angegebenen Anwendernamen.
      void setGlobalOption​(String optionKey, String optionValue)
      Setzt die Option im globalen Profil.
      void setUserOption​(String optionKey, String optionValue)
      Setzt die angegebene Option im Profil des aktuellen Anwenders.

      • Methods inherited from class Object

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

    • Constructor Detail

      • ArchiveAdapter

        public ArchiveAdapter​(Workspace workspace)
        Interner Konstruktor.
        Parameters:
        workspace - Aktueller Arbeitsbereich

    • Method Detail

      • getElement

        public ArchiveElement getElement​(int id)
                          throws RemoteException,
                                 AccessDeniedException,
                                 NotFoundException
        Liefert den Archiveintrag zu einer Objekt-ID.
        Parameters:
        id - Objekt-ID des Archiveintrags
        Returns:
        Archiveintrag (CheckoutDocument, ArchiveDocument oder StructureElement)
        Throws:
        AccessDeniedException - Wenn der Anwender nicht die nötigen Rechte hat.
        NotFoundException - Wenn das Objekt nicht gefunden werden kann.
        RemoteException - Wenn Fehler beim Lesen des Objektes vom Server auftreten.

      • getElementByArcpath

        public ArchiveElement getElementByArcpath​(String arcpath)
                                   throws RemoteException
        Liefert den Archiveintrag zu einem Archivpfad.
        Parameters:
        arcpath - Pfad zu dem Archiveintrag. Der Pfad besteht aus den Kurzbezeichnungen der Untereinträge mit beliebigem Trennzeichen. Der Pfad muss mit einem Trennzeichen beginnen.
        Returns:
        Archiveintrag (CheckoutDocument, ArchiveDocument oder StructureElement)
        Throws:
        RemoteException - Wenn Fehler beim Lesen des Objektes vom Server auftreten.

      • getElementByArcpathRelative

        public ArchiveElement getElementByArcpathRelative​(int rootId,
                                                  String arcpath)
                                           throws RemoteException
        Liefert den Archiveintrag über einen Archivpfad relativ zu einem Startordner.
        Parameters:
        rootId - Startordner
        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 (CheckoutDocument, ArchiveDocument oder StructureElement)
        Throws:
        RemoteException - Wenn Fehler beim Lesen des Objektes vom Server auftreten.
        Since:
        8.01.000

      • getElementByGuid

        public ArchiveElement getElementByGuid​(String guid)
                                throws RemoteException
        Liefert den Archiveintrag anhand seiner GUID oder ELO ObjId. Die Daten werden direkt vom Indexserver gelesen und nicht aus dem Client Cache übernommen.
        Parameters:
        guid - Die ID oder GUID (global eindeutige ID) des Archiveintrags
        Returns:
        Archiveintrag (CheckoutDocument, ArchiveDocument oder StructureElement)
        Throws:
        RemoteException - Wenn Fehler beim Lesen des Objektes vom Server auftreten.

      • getUserOption

        public String getUserOption​(String optionKey,
                            String defaultValue)
                     throws 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:
        RemoteException - Wenn Fehler beim Lesen der Option vom Server auftreten.
        Since:
        7.00.006

      • getGlobalOption

        public String getGlobalOption​(String optionKey,
                              String defaultValue)
                       throws 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:
        RemoteException - Wenn Fehler beim Lesen der Option auf dem Server auftreten.
        Since:
        7.00.006

      • setUserOption

        public void setUserOption​(String optionKey,
                          String optionValue)
                   throws RemoteException
        Setzt die angegebene Option im Profil des aktuellen Anwenders. Wenn eine Integer Option (EloJ.I.) gesetzt wird, muss der Wert ein parseInt erlauben, sonst wird eine Exception geworfen.
        Parameters:
        optionKey - Bezeichner der Option
        optionValue - Zu setzender Optionswert
        Throws:
        RemoteException - Wenn Fehler beim Speichern der Option auf dem Server auftreten.
        Since:
        7.00.006

      • setGlobalOption

        public void setGlobalOption​(String optionKey,
                            String optionValue)
                     throws RemoteException
        Setzt die Option im globalen Profil.
        Parameters:
        optionKey - Bezeichner der Option
        optionValue - Zu setzender Optionswert
        Throws:
        RemoteException - Wenn Fehler beim Speichern der Option auf dem Server auftreten.
        Since:
        7.00.006

      • getUserNames

        public List<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 List<DocMask> getDocMasks​(boolean includeDocMasks,
                                 boolean includeFolderMasks,
                                 boolean includeSearchMasks)
                          throws RemoteException
        Liefert eine Liste mit den Verschlagwortungsmasken.
        Parameters:
        includeDocMasks - Dokumentenmasken zurückliefern
        includeFolderMasks - Ordnermasken zurückliefern
        includeSearchMasks - Suchmasken zurückliefern
        Returns:
        Liste von Verschlagwortungsmasken
        Throws:
        RemoteException - Wenn Fehler beim Laden der Masken vom Server auftreten.
        Since:
        8.00.000

      • getDocMask

        public DocMask getDocMask​(String maskIdOrName)
                   throws Exception
        Liefert die Verschlagwortungsmaske für die angegebenen MaskenID zurück.
        Parameters:
        maskIdOrName - Nummer oder Name der Verschlagwortungsmaske
        Returns:
        Verschlagwortungsmaske
        Throws:
        Exception - Wenn die Maske nicht vom Server gelesen werden kann.
        Since:
        9.01.000

      • getArchiveName

        public String getArchiveName()
        Liefert den Namen des aktuellen Archiv-Profils.
        Returns:
        Name des Archiv-Profils
        Since:
        8.00.000

      • getFile

        public File getFile​(Sord sord,
                    DocVersion docVersion)
             throws InvalidKeyException,
                    DecryptCanceledException,
                    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:
        sord - Archiveintrag
        docVersion - Dokumentversion
        Returns:
        Dokumentdatei im Cache-Verzeichnis
        Throws:
        InvalidKeyException - Fehler beim Entschlüsseln.
        DecryptCanceledException - Bei Abbruch der Kennworteingabe.
        IOException - Fehler beim Laden des Dokuments.
        Since:
        8.01.000

      • lookupMaskId

        public int lookupMaskId​(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​(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

      • getReferencePaths

        public String[] getReferencePaths​(EditInfo editInfo)
                           throws IllegalArgumentException
        Liefert eine Liste mit den Referenzpfaden des angegebenen Archiveintrags zurück.
        Parameters:
        editInfo - Verschlagwortung des Archiveintrags
        Returns:
        Liste mit den Referenzpfaden
        Throws:
        IllegalArgumentException - Ungültiger Parameter
        Since:
        9.01.000

      • exportFiles

        public File exportFiles​(File destDir,
                        Enumeration<ArchiveElement> items)
                 throws Exception
        Kopiert die Dateien einer Liste von Archivdokumenten in ein Ausgabeverzeichnis.
        Parameters:
        destDir - Zielverzeichnis
        items - Archivdokumente
        Returns:
        Verzeichnis, in welches die Dateien kopiert wurden.
        Throws:
        Exception - Fehler beim Laden oder Kopieren der Dokumente