Package de.elo.client.scripting.interfaces

Klasse ArchiveAdapter

Object
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

  • Konstruktordetails

    • ArchiveAdapter

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

  • Methodendetails

    • getElement

      public ArchiveElement getElement(int id) throws RemoteException, AccessDeniedException, NotFoundException
      Liefert den Archiveintrag zu einer Objekt-ID.
      Parameter:
      id - Objekt-ID des Archiveintrags
      Gibt zurück:
      Archiveintrag (CheckoutDocument, ArchiveDocument oder StructureElement)
      Löst aus:
      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.
      Parameter:
      arcpath - Pfad zu dem Archiveintrag. Der Pfad besteht aus den Kurzbezeichnungen der Untereinträge mit beliebigem Trennzeichen. Der Pfad muss mit einem Trennzeichen beginnen.
      Gibt zurück:
      Archiveintrag (CheckoutDocument, ArchiveDocument oder StructureElement)
      Löst aus:
      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.
      Parameter:
      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.
      Gibt zurück:
      Archiveintrag (CheckoutDocument, ArchiveDocument oder StructureElement)
      Löst aus:
      RemoteException - Wenn Fehler beim Lesen des Objektes vom Server auftreten.
      Seit:
      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.
      Parameter:
      guid - Die ID oder GUID (global eindeutige ID) des Archiveintrags
      Gibt zurück:
      Archiveintrag (CheckoutDocument, ArchiveDocument oder StructureElement)
      Löst aus:
      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.
      Parameter:
      optionKey - Bezeichner der Option
      defaultValue - Defaultwert welcher zurückgegeben wird, falls die Option nicht vorhanden ist
      Gibt zurück:
      String Wert der Option
      Löst aus:
      RemoteException - Wenn Fehler beim Lesen der Option vom Server auftreten.
      Seit:
      7.00.006

    • getGlobalOption

      public String getGlobalOption(String optionKey, String defaultValue) throws RemoteException
      Liest die angegebene Option aus dem globalen Profil.
      Parameter:
      optionKey - Bezeichner der Option
      defaultValue - Defaultwert welcher zurückgegeben wird, falls die Option nicht vorhanden ist.
      Gibt zurück:
      String Wert der Option
      Löst aus:
      RemoteException - Wenn Fehler beim Lesen der Option auf dem Server auftreten.
      Seit:
      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.
      Parameter:
      optionKey - Bezeichner der Option
      optionValue - Zu setzender Optionswert
      Löst aus:
      RemoteException - Wenn Fehler beim Speichern der Option auf dem Server auftreten.
      Seit:
      7.00.006

    • setGlobalOption

      public void setGlobalOption(String optionKey, String optionValue) throws RemoteException
      Setzt die Option im globalen Profil.
      Parameter:
      optionKey - Bezeichner der Option
      optionValue - Zu setzender Optionswert
      Löst aus:
      RemoteException - Wenn Fehler beim Speichern der Option auf dem Server auftreten.
      Seit:
      7.00.006

    • getUserNames

      public List<UserName> getUserNames(boolean includeUsers, boolean includeGroups)
      Liefert eine Liste mit allen Anwendern und/oder Anwendergruppen des Archivs.
      Parameter:
      includeUsers - Bei True werden die Anwender zurückgegeben
      includeGroups - Bei True werden die Gruppen zurückgegeben
      Gibt zurück:
      Liste mit den Anwendern und/oder Anwendergruppen
      Seit:
      7.00.008

    • getDocMasks

      public List<DocMask> getDocMasks(boolean includeDocMasks, boolean includeFolderMasks, boolean includeSearchMasks) throws RemoteException
      Liefert eine Liste mit den Verschlagwortungsmasken.
      Parameter:
      includeDocMasks - Dokumentenmasken zurückliefern
      includeFolderMasks - Ordnermasken zurückliefern
      includeSearchMasks - Suchmasken zurückliefern
      Gibt zurück:
      Liste von Verschlagwortungsmasken
      Löst aus:
      RemoteException - Wenn Fehler beim Laden der Masken vom Server auftreten.
      Seit:
      8.00.000

    • getDocMask

      public DocMask getDocMask(String maskIdOrName) throws Exception
      Liefert die Verschlagwortungsmaske für die angegebenen MaskenID zurück.
      Parameter:
      maskIdOrName - Nummer oder Name der Verschlagwortungsmaske
      Gibt zurück:
      Verschlagwortungsmaske
      Löst aus:
      Exception - Wenn die Maske nicht vom Server gelesen werden kann.
      Seit:
      9.01.000

    • getArchiveName

      public String getArchiveName()
      Liefert den Namen des aktuellen Archiv-Profils.
      Gibt zurück:
      Name des Archiv-Profils
      Seit:
      8.00.000

    • getFile

      public File getFile(Sord sord, DocVersion docVersion) throws DecryptCanceledException, IOException
      Liefert die Dokumentdatei zu der übergebenen Dokumentversion. Falls die Version verschlüsselt ist, wird dem Anwender ein Dialog zu Eingabe des Kennworts angezeigt.
      Parameter:
      sord - Archiveintrag
      docVersion - Dokumentversion
      Gibt zurück:
      Dokumentdatei im Cache-Verzeichnis
      Löst aus:
      DecryptCanceledException - Bei Abbruch der Kennworteingabe.
      IOException - Fehler beim Laden des Dokuments.
      Seit:
      8.01.000

    • lookupMaskId

      public int lookupMaskId(String maskName)
      Ermittelt die Masken-Nummer zu dem angegebenen Maskennamen.
      Parameter:
      maskName - Gesuchte Maske
      Gibt zurück:
      Nummer der gesuchten Maske oder -1 falls die Maske nicht gefunden wurde
      Seit:
      8.01.000

    • lookupUserId

      public int lookupUserId(String userName)
      Ermittelt die Anwender-Nummer zu dem angegebenen Anwendernamen.
      Parameter:
      userName - Gesuchter Anwender
      Gibt zurück:
      Nummer der gesuchten Anwender oder -1 falls der Anwender nicht gefunden wurde
      Seit:
      8.01.000

    • getReferencePaths

      public String[] getReferencePaths(EditInfo editInfo) throws IllegalArgumentException
      Liefert eine Liste mit den Referenzpfaden des angegebenen Archiveintrags zurück.
      Parameter:
      editInfo - Verschlagwortung des Archiveintrags
      Gibt zurück:
      Liste mit den Referenzpfaden
      Löst aus:
      IllegalArgumentException - Ungültiger Parameter
      Seit:
      9.01.000

    • exportFiles

      public File exportFiles(File destDir, Enumeration<ArchiveElement> items) throws Exception
      Kopiert die Dateien einer Liste von Archivdokumenten in ein Ausgabeverzeichnis.
      Parameter:
      destDir - Zielverzeichnis
      items - Archivdokumente
      Gibt zurück:
      Verzeichnis, in welches die Dateien kopiert wurden.
      Löst aus:
      Exception - Fehler beim Laden oder Kopieren der Dokumente

    • createDefaultIndexingForMask

      public Sord createDefaultIndexingForMask(String mask, File docFile, int parentId) throws RemoteException
      Erstellt die Standardverschlagwortung für eine neues Objekt zu der angegebenen Maske.

      Wird eine Dokumentendatei angegeben, werden auch in der Maske definierte externe Daten und E-Mail Informationen befüllt.

      Parameter:
      mask - Masken-ID oder GUID
      docFile - Dokumentendatei oder null
      parentId - Parent falls bekannt, oder -1
      Gibt zurück:
      Verschlagwortung
      Löst aus:
      RemoteException
      Seit:
      23.00.007, 23.02.002
      Siehe auch:
      • Ungültige Referenz 
        ScriptEvents#eloCreateDefaultIndexing(Sord, int, File)