Alle Superschnittstellen:: AutoDeleteParameter, IDispatch, IUnknown

Alle bekannten Implementierungsklassen:: EloComServer

public interface IIntray extends IDispatch

Überschrift: IIntray

Beschreibung: Interface für die Postbox

Feldübersicht

Felder

Modifizierer und Typ

Feld

Beschreibung

static final String

INTERFACE_IDENTIFIER

IID für ComfyJ
Methodenübersicht

Modifizierer und Typ

Methode

Beschreibung

VariantBool

addDocumentFileAsAttachment(BStr documentFilePath, Int32 targetObjectId)

Seiteneffekte: Fügt die Dokumenten Datei mit dem angegebenen Dateipfad dem Archivdokument hinzu, welches die angegebene Objekt Id besitzt.

Int32

addDocumentFileToArchive(BStr absoluteFilePath, BStr documentName, BStr documentDate)

Fügt ein lokales Dokument in das Archiv ein.

Int32

addDocumentFileToArchivePath(BStr documentFilePath, BStr documentName, BStr documentDate, BStr archivePath)

Fügt ein lokales Dokument in das Archiv ein.

BStr

addDocumentFileToIntray(BStr absoluteFilePath)

Kopiert eine Datei aus dem lokalen Filesystem in die Postbox.

Int32

addDocumentFileToParent(Int32 parentObjectId, BStr absoluteFilePath, BStr documentName, BStr documentDate)

Fügt ein lokales Dokument unterhalb eines Parent Objekts in das Archiv ein.

BStr

getIntrayDirectoryPath()

Liefert den absoluten Dateipfad für das Postboxverzeichnis

Int32

getNumberOfIntrayFiles()

Liefert die Anzahl der Dateien in der Postbox.

BStr

getSelectedIntrayFile()

Liefert den Dateipfad der in der Postbox zuoberst selektierten Datei.

VariantBool

refreshIntray()

Lädt die Dateien in der Posbox neu.

void

scanMultiPage()

Scannt eine Menge von Seiten.

void

scanSinglePage()

Scannt eine Menge von Seiten.

void

selectAllIntrayRows()

Selektiert alle Zeilen/Dateien in der Postbox

VariantBool

selectIntrayFiles(BStr files)

Seiteneffekte: Die angegebenen Dateien werden in der Postbox selektiert.

void

selectIntrayRow(Int32 rowIndex)

Selektiert in der Postbox die Zeile mit dem angegebenen Index

VariantBool

setDateInIntray(BStr documentFileName, BStr date)

Seiteneffekte: Setzt das Dokumentendatum der angegebenen Datei in der Postbox

VariantBool

setIndexFieldInIntray(BStr documentFileName, Int32 maskId, Int32 fieldId, BStr fieldValue)

Seiteneffekte: Setzt ein Indexfeld eines Dokuments in der Postbox.

VariantBool

setNameInIntray(BStr documentFileName, BStr name)

Seiteneffekte: Setzt die Kurzbezeichnung der angegebenen Datei in der Postbox

void

setShowIndexDialog(VariantBool showIndexDialog)

Hier kann die Anzeige des Indexdialogs für die Verschlagwortung global aktiviert/deaktiviert werden.

void

unselectAllIntrayRows()

Die Auswahl von Zeilen/Dateien in der Postbox wird aufgehoben

Von Schnittstelle geerbte Methoden AutoDeleteParameter
isAutoDelete, setAutoDelete

Von Schnittstelle geerbte Methoden IDispatch
getIDsOfNames, getTypeInfo, getTypeInfoCount, invoke

Von Schnittstelle geerbte Methoden IUnknown
addRef, isNull, queryInterface, release, setNull

Felddetails
- INTERFACE_IDENTIFIER
  
  static final String INTERFACE_IDENTIFIER
  
  IID für ComfyJ
  Siehe auch:
  
  Konstantenfeldwerte
Methodendetails
- selectIntrayRow
  
  void selectIntrayRow(Int32 rowIndex)
  Selektiert in der Postbox die Zeile mit dem angegebenen Index
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
  
  Nachbedingung: In der Postbox wurde die Zeile mit dem angegebenen Index selektiert. Falls keine Zeile mit dem angegebenen Index existiert oder der Index negativ ist dann ist das Ergebnis nicht definiert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.selectIntrayRow 0
  Parameter:
  
  rowIndex - Index der Zeile die selektiert wird
- selectAllIntrayRows
  
  void selectAllIntrayRows()
  Selektiert alle Zeilen/Dateien in der Postbox
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
  
  Nachbedingung: In der Postbox wurden alle Dateien selektiert. Falls in der Postbox keine Datei ist wird auch keine Datei selektiert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.selectAllIntrayRows
- unselectAllIntrayRows
  
  void unselectAllIntrayRows()
  Die Auswahl von Zeilen/Dateien in der Postbox wird aufgehoben
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
  
  Nachbedingung: In der Postbox ist keine Zeile/Datei selektiert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.unselectAllIntrayRows
- getSelectedIntrayFile
  
  BStr getSelectedIntrayFile()
  Liefert den Dateipfad der in der Postbox zuoberst selektierten Datei.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. In der Postbox ist mindestens eine Datei selektiert.
  
  Nachbedingung: Der Dateipfad der in der Postbox zuoberst selektierten Datei wird zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.selectIntrayRow 0 filePath = Elo.getSelectedIntrayFile
  Gibt zurück:
  
  Pfad zur Dokumentendatei
- scanSinglePage
  
  void scanSinglePage()
  Scannt eine Menge von Seiten. Die Seiten werden als Einzeldateien in der Postbox gespeichert.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Ein Scanner ist an den Rechner angeschlossen und korrekt installiert (Twain Schnittstelle funktioniert).
  
  Nachbedingung: Eine Menge von Seiten wird eingescannt und als Einzeldateien in die Postbox gespeichert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.scanSinglePage
- scanMultiPage
  
  void scanMultiPage()
  Scannt eine Menge von Seiten. Die Seiten werden als Multipage Tiff Datei in der Postbox gespeichert.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Ein Scanner ist an den Rechner angeschlossen und korrekt installiert (Twain Schnittstelle funktioniert).
  
  Nachbedingung: Eine Menge von Seiten wird eingescannt und als Multipage Tiff Datei in die Postbox gespeichert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.scanMultiPage
- getNumberOfIntrayFiles
  
  Int32 getNumberOfIntrayFiles()
  Liefert die Anzahl der Dateien in der Postbox.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
  
  Nachbedingung: Die Anzahl der Dateien in der Postbox wird zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... files = Elo.getNumberOfIntrayFiles
  Gibt zurück:
  
  Die Anzahl der Dateien in der Postbox
- addDocumentFileToArchive
  
  Int32 addDocumentFileToArchive(BStr absoluteFilePath, BStr documentName, BStr documentDate)
  Fügt ein lokales Dokument in das Archiv ein. Zuerst wird der Archivdialog angezeigt. Hier kann der Anwender im Archivbaum ein Ablageordner auswählen. Das angegebene Dokument wird im ausgewählten Ordner im Archiv abgelegt.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
  
  Nachbedingung: Das Dokument ist im Archiv gespeichert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.addDocumentFileToArchive "C:/foo/bar.txt", "Strategie für 2008", "20071010130000"
  Parameter:
  
  absoluteFilePath - Quellpfad der Dokumenten Datei
  
  documentName - Kurzbezeichnung
  
  documentDate - Dokumentendatum yyyyMMddHHmmss
  
  Gibt zurück:
  
  Objekt Id des neuen Archivdokuments oder -1
- addDocumentFileToParent
  
  Int32 addDocumentFileToParent(Int32 parentObjectId, BStr absoluteFilePath, BStr documentName, BStr documentDate)
  Fügt ein lokales Dokument unterhalb eines Parent Objekts in das Archiv ein.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
  
  Nachbedingung: Das Dokument ist im Archiv gespeichert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.addDocumentFileToParent 1, "C:/foo/bar.txt", "Strategie für 2008", "20071010130000"
  Parameter:
  
  parentObjectId - Objekt Id des im Archivbaum übergeordneten Parent Objekts (Ordner)
  
  absoluteFilePath - Quellpfad der Dokumenten Datei
  
  documentName - Kurzbezeichnung
  
  documentDate - Dokumentendatum yyyyMMddHHmmss
  
  Gibt zurück:
  
  Objekt Id des neuen Archivdokuments oder -1
- addDocumentFileToIntray
  
  BStr addDocumentFileToIntray(BStr absoluteFilePath)
  Kopiert eine Datei aus dem lokalen Filesystem in die Postbox. Falls zuvor die Methode setShowIndexDialog(VariantBool) mit VariantBool.TRUE aufgerufen wurde, dann wird nach dem Einfügen die Verschlagwortung angezeigt. Wenn die Verschlagwortung mit "Abbrechen" abgebrochen wird, dann wird die Datei aus der Postbox wieder entfernt.
  
  Vorbedingug: Ein Benutzer hat sich über die login Methode angemeldet.
  
  Nachbedingung: Die angegebene Datei wurde in die Postbox kopiert.
  
  Fehlerbehandlung: Im Fehlerfall wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.addDocumentFileToIntray "C:/foo/bar.txt"
  Parameter:
  
  absoluteFilePath - Datei aus dem lokalen Filesystem. Darf keine Datei aus dem Postboxverzeichnis sein.
  
  Gibt zurück:
  
  Neuer Dateipfad in der Postbox, Leerer String bei Fehler, CANCEL bei Abbruch.
- addDocumentFileToArchivePath
  
  Int32 addDocumentFileToArchivePath(BStr documentFilePath, BStr documentName, BStr documentDate, BStr archivePath)
  Fügt ein lokales Dokument in das Archiv ein. Das Dokument wird mit dem angegebenen Namen unterhalb des Ordners abgelegt der durch den Archivpfad definiert ist.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Der angegebene Dateipfad verweist auf eine existierende lokale Datei. Das Dokumenten-Datum ist ein vierzehnstelliges ISO Datum. Der angegebene Archivpfad ist wohlgeformt und existiert im derzeit geöffneten Archiv.
  
  Nachbedingung: Das Dokument ist im Archiv gespeichert.
  
  Fehlerbehandlung: Im Fehlerfall wird -1 zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.addDocumentFileToArchivePath "C:/foo/bar.txt", "FooBar", "20071010130000", "Foo¶Bar¶Baz"
  Parameter:
  
  documentFilePath - Dateipfad der Dokumenten Datei
  
  documentName - Kurzbezeichnung für das Archiv
  
  documentDate - Dokumentendatum yyyyMMddHHmmss
  
  archivePath - Archivpfad ohne Archivname, getrennt durch ELO_SEPARATOR
  
  Gibt zurück:
  
  Objekt Id des neuen Archivdokuments oder -1
- setShowIndexDialog
  
  void setShowIndexDialog(VariantBool showIndexDialog)
  Hier kann die Anzeige des Indexdialogs für die Verschlagwortung global aktiviert/deaktiviert werden.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
  
  Nachbedingung: Beim Aufruf der Methoden addDocumentFileToArchive(BStr, BStr, BStr), addDocumentFileToArchivePath(BStr, BStr, BStr, BStr) und addDocumentFileToParent(Int32, BStr, BStr, BStr) wird der Indexdialog für die Verschlagwortung angezeigt, falls TRUE angegeben wurde.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.setShowIndexDialog(True) Elo.addDocumentFileToArchive... 'IndexDialog wird angezeigt Elo.addDocumentFileToArchivePath... 'IndexDialog wird angezeigt Elo.addDocumentFileToParent... 'IndexDialog wird angezeigt Elo.setShowIndexDialog(False) Elo.addDocumentFileToArchive... 'IndexDialog wird nicht angezeigt Elo.addDocumentFileToArchivePath... 'IndexDialog wird nicht angezeigt Elo.addDocumentFileToParent... 'IndexDialog wird nicht angezeigt
  Parameter:
  
  showIndexDialog - VariantBool.TRUE, falls der Indexdialog beim Aufruf einer der angegebenen Methoden angezeigt werden soll
  
  Seit:
  
  6.00.090
  
  Siehe auch:
  
  addDocumentFileToArchive(BStr, BStr, BStr)
  
  addDocumentFileToArchivePath(BStr, BStr, BStr, BStr)
  
  addDocumentFileToParent(Int32, BStr, BStr, BStr)
- addDocumentFileAsAttachment
  
  VariantBool addDocumentFileAsAttachment(BStr documentFilePath, Int32 targetObjectId)
  Seiteneffekte: Fügt die Dokumenten Datei mit dem angegebenen Dateipfad dem Archivdokument hinzu, welches die angegebene Objekt Id besitzt. Falls das Archivdokument bereits ein Attachment hatte wird dieses ersetzt.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Datei mit dem angegebenen Dateipfad existiert lokal. Das Archivobjekt mit der angegebenen Objekt Id ist ein Dokument und existiert im derzeit geöffneten Archiv.
  
  Nachbedingung: Das Archivobjekt mit der angegebenen Id hat die angegebene Datei als Attachment/Dateianbindung.
  
  Fehlerbehandlung: Falls einer der Punkte in der Vorbedingung nicht erfüllt ist wird VariantBool.FALSE zurückgeliefert. Bei Netzwerkfehlern, Verbindungsfehlern und anderen Fehlern wird VariantBool.FALSE zrückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... success = Elo.addDocumentFileAsAttachment("D:\action.txt",23)
  Parameter:
  
  documentFilePath - Dokumentenpfad mit der Datei für die neue Dateianbindung
  
  targetObjectId - Objekt Id eines Archivobjekts, welches ein Dokument ist
  
  Gibt zurück:
  
  VariantBool.TRUE falls kein Fehler aufgetreten ist
  
  Seit:
  
  6.00.090
- setIndexFieldInIntray
  
  VariantBool setIndexFieldInIntray(BStr documentFileName, Int32 maskId, Int32 fieldId, BStr fieldValue)
  Seiteneffekte: Setzt ein Indexfeld eines Dokuments in der Postbox.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Folgende Angaben beziehen sich auf das momentan aktive/geöffnete Archiv: Die Datei mit dem angegebenen Dateinamen existiert in der Postbox. Die Dokumentenmaske mit der angegebenen Masken Id maskId existiert. Das Maskenfeld mit der angegebenen fieldId existiert in der angegebenen Dokumentenmaske.
  
  Nachbedingung: Das Dokument hat die angegebene Dokumentenmaske zugewiesen bekommen. Das Indexfeld mit der angegebenen fieldId ist auf den Wert fieldValue gesetzt (Die Index-Informationen sind in der zugehörigen ESW-Datei gespeichert).
  
  Fehlerbehandlung: Falls einer der Punkte in der Vorbedingung nicht erfüllt ist wird VariantBool.FALSE zurückgeliefert. Bei allgemeinen Fehlern und anderen Fehlern wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... success = Elo.setIndexFieldInIntray("action.txt",3,2,"foobar")
  Parameter:
  
  documentFileName - Dateiname des Dokuments in der Postbox (ohne Pfad)
  
  maskId - Objekt Id der gewünschten Dokumentenmaske
  
  fieldId - Objekt Id des Maskenfelds in der Dokumentenmaske
  
  fieldValue - Neuer Wert des Maskenfelds
  
  Gibt zurück:
  
  VariantBool.TRUE, falls die Vorbedingung erfüllt ist und das Setzen des Indexfelds erfolgreich war bzw. kein Fehler aufgetreten ist
  
  Seit:
  
  6.00.090
- setNameInIntray
  
  VariantBool setNameInIntray(BStr documentFileName, BStr name)
  Seiteneffekte: Setzt die Kurzbezeichnung der angegebenen Datei in der Postbox
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Datei mit dem angegebenen Dateinamen existiert in der Postbox.
  
  Nachbedingung: Die Postbox-Datei mit dem angegebenen Dateinamen hat den angegebenen Namen als neue Kurzbezeichung. Die Kurzbezeichnung ist in der ESW-Datei gespeichert.
  
  Fehlerbehandlung: Falls einer der Punkte in der Vorbedingung nicht erfüllt ist wird VariantBool.FALSE zurückgeliefert. Bei allgemeinen Fehlern und anderen Fehlern wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... success = Elo.setNameInIntray("action.txt","foobar")
  Parameter:
  
  documentFileName - Name der Dokumentendatei ohne Dateipfad
  
  name - Beliebige Kurzbezeichnung
  
  Gibt zurück:
  
  VariantBool.TRUE, falls die Vorbedingung erfüllt ist und kein Fehler aufgetreten ist
  
  Seit:
  
  6.00.090
- setDateInIntray
  
  VariantBool setDateInIntray(BStr documentFileName, BStr date)
  Seiteneffekte: Setzt das Dokumentendatum der angegebenen Datei in der Postbox
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Datei mit dem angegebenen Dateinamen existiert in der Postbox. Das angegebene Dokumentendatum ist ein 14-stelliges ISO Datum.
  
  Nachbedingung: Die Postbox-Datei mit dem angegebenen Dateinamen hat das angegebene Dokumentendatum. Das neue Dokumentendatum ist in der ESW-Datei gespeichert.
  
  Fehlerbehandlung: Falls einer der Punkte in der Vorbedingung nicht erfüllt ist wird VariantBool.FALSE zurückgeliefert. Bei allgemeinen Fehlern und anderen Fehlern wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... success = Elo.setDateInIntray("action.txt","20080814142700")
  Parameter:
  
  documentFileName - Name der Dokumentendatei ohne Dateipfad
  
  date - Dokumentendatum yyyyMMddHHmmss
  
  Gibt zurück:
  
  VariantBool.TRUE, falls die Vorbedingung erfüllt ist und kein Fehler aufgetreten ist
  
  Seit:
  
  6.00.090
- selectIntrayFiles
  
  VariantBool selectIntrayFiles(BStr files)
  Seiteneffekte: Die angegebenen Dateien werden in der Postbox selektiert. Die Dateien werden über den Dateinamen (ohne Dateipfad) identifiziert.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Dateien mit den angegebenen Dateinamen sind in der Postbox vorhanden. Für jeden der angegebenen Dateinamen existiert eine Datei in der Postbox. Keiner der Dateinamen ist ein Dateipfad.
  
  Nachbedingung: Die angegebenen Dateien sind in der Postbox selektiert.
  
  Fehlerbehandlung: Falls die Vorbedingung nicht erfüllt ist wird die Selektion nicht ausgeführt. Stattdessen wird VariantBool.FALSE zurückgeliefert. Bei allgemeinen und anderen Fehlern wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... success = Elo.selectIntrayFiles("foo.txt¶bar.txt¶baz.txt")
  Parameter:
  
  files - Dateinamen, getrennt durch ELO_SEPARATOR ¶
  
  Gibt zurück:
  
  VariantBool.TRUE falls die Vorbedingung erfüllt ist und kein Fehler aufgetreten ist
  
  Seit:
  
  6.00.100
- getIntrayDirectoryPath
  
  BStr getIntrayDirectoryPath()
  Liefert den absoluten Dateipfad für das Postboxverzeichnis
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
  
  Nachbedingung: Der Dateipfad für das derzeit aktive Postboxverzeichnis wird zurückgeliefert.
  
  Fehlerbehandlung: Im Fehlerfall wird ein leerer String zurückgeliefert
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... intrayDir = Elo.getIntrayDirectoryPath
  Gibt zurück:
  
  Absoluter Dateipfad für das Postboxverzeichnis
  
  Seit:
  
  6.00.100
- refreshIntray
  
  VariantBool refreshIntray()
  Lädt die Dateien in der Posbox neu. Dies ist hilfreich wenn sich die Dateien im Filesystem geändert haben (hinzugefügt, gelöscht, geändert).
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Postbox Ansicht ist aktiv.
  
  Nachbedingung: Der aktuelle Status des Filesystems wird in der Postbox Ansicht angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.refreshIntray();
  Gibt zurück:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
  
  Seit:
  
  6.00.100

Schnittstelle IIntray

Feldübersicht

Methodenübersicht

Von Schnittstelle geerbte Methoden AutoDeleteParameter

Von Schnittstelle geerbte Methoden IDispatch

Von Schnittstelle geerbte Methoden IUnknown

Felddetails

INTERFACE_IDENTIFIER

Methodendetails

selectIntrayRow

selectAllIntrayRows

unselectAllIntrayRows

getSelectedIntrayFile

scanSinglePage

scanMultiPage

getNumberOfIntrayFiles

addDocumentFileToArchive

addDocumentFileToParent

addDocumentFileToIntray

addDocumentFileToArchivePath

setShowIndexDialog

addDocumentFileAsAttachment

setIndexFieldInIntray

setNameInIntray

setDateInIntray

selectIntrayFiles

getIntrayDirectoryPath

refreshIntray