Package de.elo.client.comserver

Interface IDocument

All Superinterfaces:
AutoDeleteParameter, IDispatch, IUnknown
All Known Implementing Classes:
EloComServer
public interface IDocument
extends IDispatch

Überschrift: IDocument

Beschreibung: COM Schnittstelle für Dokumente

Copyright: Copyright (c) ELO Digital Office GmbH 2007

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static Int32 CHECKIN_ERROR
    Fehler beim Checkin eines Dokuments
    static Int32 CHECKIN_SUCCESS
    Checkin war erfolgreich
    static Int32 CURRENT_CHECKOUT
    Checkout Verzeichnis des aktuellen Archivs
    static Int32 CURRENT_DOC_CACHE
    Dokumenten Cache Verzeichnis des aktuellen Archivs
    static Int32 CURRENT_INTRAY
    Postbox Verzeichnis des aktuellen Archivs
    static Int32 CURRENT_TEMP
    Temp Verzeichnis des aktuellen Archivs
    static Int32 FILE_IS_NOT_IN_CHECKOUT_DIR
    Die Datei ist nicht im aktuellen Checkout Verzeichnis
    static Int32 FOREIGN_CHECKOUT
    Checkout Verzeichnis eines anderen Archivs
    static Int32 FOREIGN_DOC_CACHE
    Dokumenten Cache Verzeichnis eines anderen Archivs
    static Int32 FOREIGN_INTRAY
    Postbox Verzeichnis eines anderen Archivs
    static Int32 FOREIGN_TEMP
    Temp Verzeichnis eines anderen Archivs
    static String INTERFACE_IDENTIFIER
    IID für ComfyJ
    static Int32 UNKNOWN_ORIGIN
    Unbekanntes Herkunfts Verzeichnis

  • Method Summary

    Modifier and Type Method Description
    void activateAttachmentOfSelectedDocument()
    Öffnet die Dateianbindung eines in der Baumansicht selektierten Dokuments mit einem externen Programm.
    VariantBool addAttachmentToSelectedDocument​(BStr attachmentFilePath)
    Fügt dem in der Baumansicht ausgewählten Dokument eine Dateianbindung (Attachment) hinzu.
    Int32 checkInDocument​(BStr absoluteFilePath, BStr documentDate)
    Die ausgecheckte Datei mit dem angegebenen Dateipfad wird in das Archiv eingecheckt.
    void checkInSelectedDocument()
    Das in der Baumansicht ausgewählte Dokument wird eingecheckt bzw. zur Sicherung auf den Server übertragen.
    BStr checkOutDocument​(Int32 objectId)
    Das aktuelle Dokument des Archivobjekts mit der angegebenen Objekt Id wird ausgecheckt.
    void checkOutSelectedDocument()
    Das in der Baumansicht ausgewählte Dokument wird zur Bearbeitung ausgecheckt.
    BStr createTempCopy​(Int32 objectId)
    Seiteneffekte: Erzeugt eine Kopie des Archivdokuments mit der angegebenen Objekt Id im lokalen Temp-Verzeichnis des Archivs.
    BStr getAttachmentFilePaths​(Int32 objectId)
    Liefert die lokal gecacheten Attachment Dateien für ein Dokument im Archiv
    Int32 getFileOrigin​(BStr absoluteFilePath)
    Liefert den Code für das Herkunftsverzeichnis einer Datei begzüglich auf das momentan geöffnete Archiv.
    BStr getLinks​(Int32 objectId)
    Liefert die Objekt Ids der verlinkten Archivobjekte
    BStr getMD5Hash​(BStr filePath)
    Liefert den MD5 Hash für eine lokale Datei
    Int32 getSelectedDocumentId()
    Liefert die Objekt-Id eines in der Baumansicht selektierten Dokuments.
    BStr getSelectedDocumentName()
    Liefert den Namen eines in der Baumansicht selektierten Dokuments.
    void openSelectedDocument()
    Das in der Baumansicht ausgewählte Dokument wird geöffnet und von einem externen Programm angezeigt.
    void printSelectedDocument()
    Das in der Baumansicht ausgewählte Dokument wird gedruckt.
    void removeAttachmentOfSelectedDocument()
    Entfernt die Dateianbindung des in der Baumansicht selektierten Dokuments.
    VariantBool sendSelectedDocument​(BStr receiverMailAddress)
    Das in der Baumansicht ausgewählte Dokument wird wird an die angegebene E-Mail Adresse gesendet.

    Methods inherited from interface AutoDeleteParameter

    isAutoDelete, setAutoDelete

    Methods inherited from interface IDispatch

    getIDsOfNames, getTypeInfo, getTypeInfoCount, invoke

    Methods inherited from interface IUnknown

    addRef, isNull, queryInterface, release, setNull

  • Field Details

    • INTERFACE_IDENTIFIER

      static final String INTERFACE_IDENTIFIER
      IID für ComfyJ
      See Also:
      Constant Field Values

    • UNKNOWN_ORIGIN

      static final Int32 UNKNOWN_ORIGIN
      Unbekanntes Herkunfts Verzeichnis

    • CURRENT_CHECKOUT

      static final Int32 CURRENT_CHECKOUT
      Checkout Verzeichnis des aktuellen Archivs

    • CURRENT_DOC_CACHE

      static final Int32 CURRENT_DOC_CACHE
      Dokumenten Cache Verzeichnis des aktuellen Archivs

    • CURRENT_INTRAY

      static final Int32 CURRENT_INTRAY
      Postbox Verzeichnis des aktuellen Archivs

    • CURRENT_TEMP

      static final Int32 CURRENT_TEMP
      Temp Verzeichnis des aktuellen Archivs

    • FOREIGN_CHECKOUT

      static final Int32 FOREIGN_CHECKOUT
      Checkout Verzeichnis eines anderen Archivs

    • FOREIGN_DOC_CACHE

      static final Int32 FOREIGN_DOC_CACHE
      Dokumenten Cache Verzeichnis eines anderen Archivs

    • FOREIGN_INTRAY

      static final Int32 FOREIGN_INTRAY
      Postbox Verzeichnis eines anderen Archivs

    • FOREIGN_TEMP

      static final Int32 FOREIGN_TEMP
      Temp Verzeichnis eines anderen Archivs

    • CHECKIN_SUCCESS

      static final Int32 CHECKIN_SUCCESS
      Checkin war erfolgreich

    • CHECKIN_ERROR

      static final Int32 CHECKIN_ERROR
      Fehler beim Checkin eines Dokuments

    • FILE_IS_NOT_IN_CHECKOUT_DIR

      static final Int32 FILE_IS_NOT_IN_CHECKOUT_DIR
      Die Datei ist nicht im aktuellen Checkout Verzeichnis

  • Method Details

    • checkInSelectedDocument

      void checkInSelectedDocument()

      Das in der Baumansicht ausgewählte Dokument wird eingecheckt bzw. zur Sicherung auf den Server übertragen.

      Vorbedingung: Ein Dokument ist in der Baumansicht ausgewählt. Das Dokument ist entweder neu angelegt worden oder befindet sich im ausgecheckten Zustand (eckige Klammern).

      Nachbedingung: Das Dokument wurde eingecheckt bzw. auf den Server übertragen.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument in ausgechecktem Zustand
 Elo.checkInSelectedDocument

    • checkOutSelectedDocument

      void checkOutSelectedDocument()

      Das in der Baumansicht ausgewählte Dokument wird zur Bearbeitung ausgecheckt.

      Vorbedingung: Ein Dokument ist in der Baumansicht ausgewählt. Das Dokument ist in eingechecktem Zustand (keine eckigen Klammern) und nicht von einem anderen Benutzer gesperrt.

      Nachbedingung: Das Dokument ist in ausgechecktem Zustand.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument in eingechecktem Zustand
 Elo.checkOutSelectedDocument

    • checkOutDocument

      BStr checkOutDocument​(Int32 objectId)

      Das aktuelle Dokument des Archivobjekts mit der angegebenen Objekt Id wird ausgecheckt.

      Vorbedingung: Das Archivobjekt mit der angegebenen Objekt Id ist ein Dokument und ist nicht ausgecheckt.

      Nachbedingung: Das Dokument ist in ausgechecktem Zustand. Der Dateipfad des Dokuments wird zurückgegeben.

      Fehlerbehandlung: Im Fehlerfall wird ein leerer String zurückgeliefert.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 path = Elo.checkOutDocument(1198436)
      Parameters:
      objectId - Objekt Id des Archivobjekts
      Returns:
      Dateipfad des ausgecheckten Dokuments

    • openSelectedDocument

      void openSelectedDocument()

      Das in der Baumansicht ausgewählte Dokument wird geöffnet und von einem externen Programm angezeigt.

      Vorbedingung: Ein Dokument ist in der Baumansicht ausgewählt. Für den Dateityp ist ein externes Programm zur Anzeige registriert.

      Nachbedingung: Das Dokument wurde geöffnet und wird von einem externen Programm angezeigt.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 Elo.openSelectedDocument

    • printSelectedDocument

      void printSelectedDocument()

      Das in der Baumansicht ausgewählte Dokument wird gedruckt.

      Vorbedingung: Ein Dokument ist in der Baumansicht ausgewählt.

      Nachbedingung: Das Dokument wurde gedruckt.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 Elo.printSelectedDocument

    • sendSelectedDocument

      VariantBool sendSelectedDocument​(BStr receiverMailAddress)

      Das in der Baumansicht ausgewählte Dokument wird wird an die angegebene E-Mail Adresse gesendet.

      Vorbedingung: Ein Dokument ist in der Baumansicht ausgewählt.

      Nachbedingung: Das Dokument wurde an die angegebene E-Mail Adresse gesendet.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 Elo.sendSelectedDocument "foo@bar.com"
      Parameters:
      receiverMailAddress - E-Mail Adresse des Empfängers (gemäß RFC 2822)
      Returns:
      True, falls keine Exception aufgetreten ist

    • addAttachmentToSelectedDocument

      VariantBool addAttachmentToSelectedDocument​(BStr attachmentFilePath)

      Fügt dem in der Baumansicht ausgewählten Dokument eine Dateianbindung (Attachment) hinzu.

      Vorbedingung: Ein Dokument ist in der Baumansicht ausgewählt.

      Nachbedingung: Das Dokument ist mit der angegebenen Dateianbindung (Attachment) verknüpft.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 Elo.addAttachmentToSelectedDocument "C:/foo/bar/attachment.txt"
      Parameters:
      attachmentFilePath - Dateipfad zu der Dateianbindung (Attachment)
      Returns:
      True, falls keine Exception aufgetreten ist

    • removeAttachmentOfSelectedDocument

      void removeAttachmentOfSelectedDocument()

      Entfernt die Dateianbindung des in der Baumansicht selektierten Dokuments.

      Vorbedingung: Ein Dokument ist in der Baumansicht ausgewählt. Das Dokument ist mit einer Dateianbindung verknüpft (Büroklammer Icon aktiv).

      Nachbedingung: Die Dateianbindung wurde entfernt/gelöscht, falls vorhanden.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument mit Dateianbindung
 Elo.removeAttachmentOfSelectedDocument

    • activateAttachmentOfSelectedDocument

      void activateAttachmentOfSelectedDocument()

      Öffnet die Dateianbindung eines in der Baumansicht selektierten Dokuments mit einem externen Programm.

      Vorbedingung: Ein Dokument ist in der Baumansicht ausgewählt. Das Dokument ist mit einer Dateianbindung verknüpft (Büroklammer Icon aktiv). Für das Dateiformat der Dateianbindung ist ein externes Programm registriert.

      Nachbedingung: Die Dateianbindung wird in einem externen Programm angezeigt.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument mit Dateianbindung
 Elo.activateAttachmentOfSelectedDocument

    • getSelectedDocumentId

      Int32 getSelectedDocumentId()

      Liefert die Objekt-Id eines in der Baumansicht selektierten Dokuments.

      Vorbedingung: Ein Dokument ist in der Baumansicht ausgewählt.

      Nachbedingung: Die Objekt-Id des selektierten Dokuments wird zurückgegeben.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 documentId = Elo.getSelectedDocumentId
      Returns:
      Object-Id

    • getSelectedDocumentName

      BStr getSelectedDocumentName()

      Liefert den Namen eines in der Baumansicht selektierten Dokuments.

      Vorbedingung: Ein Dokument ist in der Baumansicht ausgewählt.

      Nachbedingung: Der Name des selektierten Dokuments wird zurückgegeben.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 documentName = Elo.getSelectedDocumentName
      Returns:
      Kurzbezeichnung

    • getFileOrigin

      Int32 getFileOrigin​(BStr absoluteFilePath)

      Liefert den Code für das Herkunftsverzeichnis einer Datei begzüglich auf das momentan geöffnete Archiv.

      Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.

      Nachbedingung: Der Code für das Herkunftsverzeichnis der Datei wurde zurückgeliefert.

      Fehlerbehandlung: Im Fehlerfall wird UNKNOWN_ORIGIN zurückgeliefert. Falls der Dateipfad ungültig ist wird UNKNOWN_ORIGIN zurückgeliefert.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 Result = Elo.getFileOrigin("C:\Dokumente und Einstellungen\Neun\ELO Digital Office\SRVT 02 6080\checkout\foobar.pdf")
 ' Result should be CURRENT_CHECKOUT
      Parameters:
      absoluteFilePath - Gültiger lokaler absoluter Dateipfad einer beliebigen (existierenden) Datei
      Returns:

    • checkInDocument

      Int32 checkInDocument​(BStr absoluteFilePath, BStr documentDate)

      Die ausgecheckte Datei mit dem angegebenen Dateipfad wird in das Archiv eingecheckt.

      Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Der Dateipfad verweist auf eine lokale Datei im aktuellen Checkout Verzeichnis.

      Nachbedingung: Die ausgecheckte Datei ist im Archiv eingecheckt worden. CHECKIN_SUCCESS wurde zurückgeliefert.

      Fehlerbehandlung: Falls der Dateipfad nicht auf eine Datei im aktuellen Checkout Verzeichnis verweist wird FILE_IS_NOT_IN_CHECKOUT_DIR zurückgeliefert. Falls der Dateipfad ungültig ist bzw. nicht auf eine Datei verweist wird CHECKIN_ERROR zurückgeliefert.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 Result = Elo.checkinDocument("C:\Dokumente und Einstellungen\Neun\ELO Digital Office\SRVT 02 6080\checkout\foobar.pdf","")
 ' Result should be CHECKIN_SUCCESS
      Parameters:
      absoluteFilePath - Gültiger lokaler absoluter Dateipfad einer Datei im aktuellen Checkout Verzeichnis
      documentDate - ISO Datum
      Returns:

    • createTempCopy

      BStr createTempCopy​(Int32 objectId)

      Seiteneffekte: Erzeugt eine Kopie des Archivdokuments mit der angegebenen Objekt Id im lokalen Temp-Verzeichnis des Archivs.

      Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Das Archivobjekt mit der angegebenen Objekt Id existiert und ist ein Dokument.

      Nachbedingung: Das Archivdokument wurde in das lokale Temp-Verzeichnis des geöffneten Archivs kopiert. Der Dateipfad der Kopie wird zurückgeliefert.

      Fehlerbehandlung: Im Falle eines Fehlers wird ein leerer String zurückgeliefert.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 filePath = Elo.createTempCopy(23)   'C:/<xyz>/test.txt
      Parameters:
      objectId - Objekt Id eines Dokuments im geöffneten Archiv
      Returns:
      Dateipfad der Kopie im lokalen Temp-Verzeichnis des Archivs

    • getMD5Hash

      BStr getMD5Hash​(BStr filePath)

      Liefert den MD5 Hash für eine lokale Datei

      Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Die Datei mit dem angegebenen Dateipfad existiert lokal.

      Nachbedingung: Der MD5 Hash für die Datei wird zurückgeliefert

      Fehlerbehandlung: Im Falle eines Fehlers wird ein leerer String zurückgeliefert.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 hash = Elo.getMD5Hash("C:\log.txt")
      Parameters:
      filePath - Gültiger Dateipfad
      Returns:
      MD5 Hashwert

    • getLinks

      BStr getLinks​(Int32 objectId)

      Liefert die Objekt Ids der verlinkten Archivobjekte

      Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Das Archivobjekt mit der angegebenen Objekt Id existiert im derzeit geöffneten Archiv.

      Nachbedingung: Die Objekt Ids der verlinkten Archivobjekte werden zurückgeliefert (getrennt durch ClientConstants.ELO_SEPARATOR). Falls es keine verlinkten Archivobjekte gibt wird ein leerer String zurückgeliefert.

      Fehlerbehandlung: Im Falle eines Fehlers wird ein leerer String zurückgeliefert.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 links = Elo.getLinks(234234)   '1???
      Parameters:
      objectId - Objekt Id eines existierenden Archivobjekts
      Returns:
      Objekt Ids der verlinkten Archivobjekte, getrennt durch ClientConstants.ELO_SEPARATOR

    • getAttachmentFilePaths

      BStr getAttachmentFilePaths​(Int32 objectId)

      Liefert die lokal gecacheten Attachment Dateien für ein Dokument im Archiv

      Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Das Archivobjekt mit der angegebenen Objekt Id existiert im derzeit geöffneten Archiv.

      Nachbedingung: Die Pfade der lokal gecacheten Attachment Dateien werden zurückgeliefert (getrennt durch ClientConstants.ELO_SEPARATOR). Falls es keine solchen gibt wird ein leerer String zurückgeliefert.

      Fehlerbehandlung: Im Falle eines Fehlers wird ein leerer String zurückgeliefert.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 attachments = Elo.getAttachmentFilePaths(234234)   '<pfad>?lt;pfad>?lt;pfad>
      Parameters:
      objectId - Objekt Id eines Dokuments im Archiv
      Returns:
      Pfade der Attachment Dateien