Object

IUnknownServer

IDispatchServer

DispatchComServer

EloComServer

All Implemented Interfaces:: AutoDeleteParameter, IDispatch, IPersist, IUnknown, IAppointment, IArchivedObject, IDocument, IIntray, IMask, INavigation, IObjectProperties, IPreview, IReminder, ISearch, IUser, IWorkflow, IWorkspace

public class EloComServer
extends DispatchComServer
implements IPersist, IWorkspace, IWorkflow, IPreview, IDocument, ISearch, IArchivedObject, IUser, IIntray, INavigation, IReminder, IMask, IObjectProperties

Überschrift: EloComServer

Beschreibung: COM Server. Damit kann der Java Client über die COM Schnittstelle gestartet/gesteuert werden. Der COM Server basiert auf Comfyj (www.teamdev.com/comfyj/).

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

Field Summary

Fields
Modifier and Type	Field	Description
`static CLSID`	`COM_SERVER_CLSID`	KlassenId des COM-Servers
`static String`	`COM_SERVER_DESCRIPTION`	Programmbezeichnung
`static String`	`PROG_ID`	Programm-ID
`static String`	`VERSION_INDEPENDENT_PROG_ID`	Unabhängige Programm-ID

Fields inherited from class IDispatchServer

a, A, b, B, C, D, E, g, i, k, L, N, r, u, v, y

Fields inherited from class IUnknownServer

t

Fields inherited from interface IArchivedObject

INTERFACE_IDENTIFIER

Fields inherited from interface IDispatch

INTERFACE_IDENTIFIER

Fields inherited from interface IDocument

CHECKIN_ERROR, CHECKIN_SUCCESS, CURRENT_CHECKOUT, CURRENT_DOC_CACHE, CURRENT_INTRAY, CURRENT_TEMP, FILE_IS_NOT_IN_CHECKOUT_DIR, FOREIGN_CHECKOUT, FOREIGN_DOC_CACHE, FOREIGN_INTRAY, FOREIGN_TEMP, INTERFACE_IDENTIFIER, UNKNOWN_ORIGIN

Fields inherited from interface IIntray

INTERFACE_IDENTIFIER

Fields inherited from interface IMask

INTERFACE_IDENTIFIER

Fields inherited from interface INavigation

INTERFACE_IDENTIFIER

Fields inherited from interface IObjectProperties

INTERFACE_IDENTIFIER

Fields inherited from interface IPersist

INTERFACE_IDENTIFIER

Fields inherited from interface IPreview

INTERFACE_IDENTIFIER

Fields inherited from interface IReminder

INTERFACE_IDENTIFIER

Fields inherited from interface ISearch

INTERFACE_IDENTIFIER

Fields inherited from interface IUnknown

INTERFACE_IDENTIFIER

Fields inherited from interface IUser

INTERFACE_IDENTIFIER

Fields inherited from interface IWorkflow

INTERFACE_IDENTIFIER

Fields inherited from interface IWorkspace

ARCHIVE_NOT_FOUND, COULD_NOT_CONNECT, EXCEPTION, INTERFACE_IDENTIFIER, OK

Constructor Summary

Constructors

Constructor Description

EloComServer(CoClassMetaInfo classImpl)
Konstruktor.

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.
`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.
`Int32`	`ARCHIVE_NOT_FOUND()`	Konstante: Das Archiv wurde nicht gefunden
`VariantBool`	`archivePathExists(BStr archivePath)`	`VariantBool.TRUE`, falls der angegebene Archivpfad im aktuell geöffneten Archiv vorhanden ist.
`void`	`awaitLogin()`	Blockiert den weiteren COM Ablauf bis ein erfolgreicher Login durchgeführt wurde.
`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 documentId)`	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.
`Int32`	`chooseTargetObject(Int32 mode, BStr dialogTitle)`	Der `TreeSelectDialog` wird angezeigt.
`void`	`clear()`	Löscht die aktuelle Dokumentenvorschau und zeigt die Meldung "Kein Dokument zur Ansicht ausgewählt." an.
`Int32`	`commitMaskSearch()`	Startet die Maskensuche.
`VariantBool`	`commitObject()`	Beendet die Bearbeitung des aktuellen Archivobjekts und speichert die Änderungen auf den Indexserver.
`Int32`	`COULD_NOT_CONNECT()`	Konstante: Verbindungsfehler
`Int32`	`createNewReminder(Int32 objectId, BStr receiverIds, BStr name, BStr message)`	Erstellt einen neuen Wiedervorlage Termin
`VariantBool`	`createReference(Int32 objectId, Int32 newParentId)`	Erzeugt eine Referenz für ein Archivobjekt in einem Archivordner.
`VariantBool`	`createSubFolder(BStr archivePath, BStr folderName)`	Erstellt einen neuen Unterordner unterhalb des angegebenen Archivpfades.
`BStr`	`createTempCopy(Int32 objectId)`	Seiteneffekte: Erzeugt eine Kopie des Archivdokuments mit der angegebenen Objekt Id im lokalen Temp-Verzeichnis des Archivs.
`void`	`deactivate()`	Löscht die aktuelle Dokumentenvorschau und zeigt die Meldung "Dokument extern geöffnet, Preview deaktiviert." an.
`void`	`destroy()`
`void`	`displayLocalFile(BStr fileName)`	Stellt die Dokumentenvorschau auf eine lokale Datei, z.B. aus der Postbox ein.
`void`	`doDestroy()`
`Int32`	`EXCEPTION()`	Konstante: Eine Exception ist aufgetreten
`Int32`	`getActiveView()`	Liefert den Code für die momentan aktive Ansicht
`BStr`	`getArchiveLocation()`	Liefert den Archivpfad des aktiven Archivs.
`BStr`	`getArchiveName()`	Liefert den Archivnamen des aktiven Archivs.
`BStr`	`getAttachmentFilePaths(Int32 objectId)`	Liefert die lokal gecacheten Attachment Dateien für ein Dokument im Archiv
`void`	`getClassID(CLSID pClassID)`	This method retrieves the class identifier (CLSID) of an object.
`BStr`	`getComServerDescription()`	Liefert die COM Server-Beschreibung zurück.
`BStr`	`getDelimiter()`	Das Trennzeichen für Arrays, die in Strings kodiert werden.
`Int32`	`getFileOrigin(BStr absoluteFilePath)`	Liefert den Code für das Herkunftsverzeichnis einer Datei begzüglich auf das momentan geöffnete Archiv.
`BStr`	`getGroupNames()`	Liefert alle vorhandenen Gruppennamen in einem String.
`Int32`	`getIdFromArchivePath(BStr archivePath)`	Liefert die Objekt Id eines Archivobjekts, welches über den angegebenen Archivpfad identifiziert wird.
`BStr`	`getIndexField(Int32 objectId, Int32 fieldId)`	Liefert den Wert des Indexfelds mit der angegebenen `fieldId` für das Archivobjekt mit der angegebenen `objectId`:
`BStr`	`getIntrayDirectoryPath()`	Liefert den absoluten Dateipfad für das Postboxverzeichnis
`BStr`	`getLastScriptResult()`	Liefert den Rückgabewert des letzten `IWorkspace.runScriptFunction(BStr, BStr)` oder `IWorkspace.runScriptFunctionEx(BStr, BStr)` aufrufs.
`BStr`	`getLinks(Int32 objectId)`	Liefert die Objekt Ids der verlinkten Archivobjekte
`BStr`	`getMaskFields(Int32 maskId)`	Liefert die Maskenfelder der Maske mit der angegebenen Masken Id.
`BStr`	`getMaskIds()`	Die Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.
`BStr`	`getMaskNames()`	Alle Maskennamen des aktiven Archivs werden zurückgeliefert.
`BStr`	`getMaskNamesAndIds()`	Die Maskennamen und Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.
`BStr`	`getMD5Hash(BStr filePath)`	Liefert den MD5 Hash für eine lokale Datei
`Int32`	`getNumberOfIntrayFiles()`	Liefert die Anzahl der Dateien in der Postbox.
`BStr`	`getObjAclEx(Int32 objectId)`	Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen.
`Int32`	`getObjectMaskId(Int32 objectId)`	Liefert die Masken Id des Archivobjekts mit der angegebenen Objekt Id
`BStr`	`getObjectTreePath(Int32 objectId)`	Liefert den Pfad des Archivobjekts im Archivbaum.
`BStr`	`getProgId()`	Liefert die Programm-Id zurück.
`BStr`	`getReminderCreateDate()`	Liefert das Erstellungsdatum des selektierten Wiedervorlagetermins
`BStr`	`getReminderDescription()`	Liefert den Beschreibungstext des selektierten Wiedervorlagetermins.
`BStr`	`getReminderName()`	Liefert den Namen des Wiedervorlagetermins
`Int32`	`getReminderPriority()`	Liefert die Priorität des selektierten Wiedervorlagetermins.
`BStr`	`getReminderPromptDate()`	Liefert den Termin für die Wiedervorlage
`Int32`	`getReminderReceiverId()`	Liefert die Benutzer Id des Empfängers für einen selektierten Wiedervorlagetermin
`Int32`	`getReminderSenderId()`	Liefert die Benutzer Id des Absenders/Erzeugers des selektierten Wiedervorlagetermins
`Int32`	`getSelectedDocumentId()`	Liefert die Objekt-Id eines in der Baumansicht selektierten Dokuments.
`BStr`	`getSelectedDocumentName()`	Liefert den Namen eines in der Baumansicht selektierten Dokuments.
`BStr`	`getSelectedIntrayFile()`	Liefert den Dateipfad der in der Postbox zuoberst selektierten Datei.
`Int32`	`getSelectedObjectChildCount()`	Liefert die Anzahl der Kindknoten eines im Archiv/Klemmbrett selektierten Objekts.
`BStr`	`getSelectedObjectExternalIsoDate()`	Liefert das externe Datum (Dokumentendatum) für ein selektiertes ArchivObjekt.
`BStr`	`getSelectedObjectGUID()`	Liefert die `GUID` eines im Archiv/Klemmbrett selektierten Objekts.
`Int32`	`getSelectedObjectId()`	Liefert die Objekt Id eines im Archiv/Klemmbrett selektierten Objekts.
`BStr`	`getSelectedObjectInternalIsoDate()`	Liefert das interne Datum (Ablagedatum) für ein selektiertes ArchivObjekt.
`BStr`	`getSelectedObjectName()`	Liefert die Kurzbezeichnung eines im Archiv/Klemmbrett selektierten Objekts.
`Int32`	`getSelectedObjectParentId()`	Liefert die Parent Id eines im Archiv/Klemmbrett selektierten Objekts.
`Int32`	`getSelectedObjectType()`	Liefert den Typ eines im Archiv/Klemmbrett selektierten Objekts.
`BStr`	`getSubFolders(BStr archivePath)`	Liefert die Namen der Unterverzeichnisse zu dem angegebenen Archivpfad.
`BStr`	`getUserNameEx(Int32 userId)`	Liefert den Benutzernamen zu einer existierenden Benutzer Id.
`BStr`	`getUserNames()`	Liefert alle vorhandenen Benutzernamen in einem String.
`BStr`	`getVersion()`	Liefert die aktuelle Versionsnummer des Java Clients.
`BStr`	`getVersionIndependentProgId()`	Liefert die versionsunabhängige Programm-Id zurück.
`void`	`goBackward()`	Geht einen Schritt zurück.
`void`	`goForward()`	Geht einen Schritt vor
`VariantBool`	`gotoEcd(BStr filePath)`	Zeigt den Inhalt einer ECD Datei an.
`VariantBool`	`gotoGuid(BStr guid)`	Der Archivteintrag mit der angegebnen GUID wird im TreeView in der Archivansicht ausgewählt/selektiert.
`VariantBool`	`gotoObjectId(Int32 id)`	Der Archivteintrag mit der angegebnen Objekt ID wird im TreeView in der Archivansicht ausgewählt/selektiert.
`VariantBool`	`gotoReminder(Int32 reminderId)`	Wechselt in die Aufgabenansicht und selektiert den Wiedervorlagetermin mit der angegebenen Objekt Id.
`VariantBool`	`gotoWorkflow(Int32 workflowId, Int32 nodeId)`	Wechselt in die Aufgabenansicht und zeigt den angegebenen Workflow an.
`VariantBool`	`hasNext()`	Liefert `VariantBool.TRUE` falls das letzte Element des Iterators noch nicht erreicht wurde.
`VariantBool`	`isLoginVisible()`	Abfrage ob der Login-Dialog sichtbar ist.
`Int32`	`login2(BStr archiveName, BStr archivePath, BStr userName, BStr userPassword)`	Die Login-Methode authentifiziert einen Benutzer für den Zugriff auf ein Archiv.
`VariantBool`	`loginWithDialog()`	Startet den Login Dialog.
`VariantBool`	`makeLink(Int32 sourceObjectId, Int32 destinationObjectId)`	Seiteneffekte: Verlinkt das Quellobjekt (Source) mit dem Zielobjekt (Destination).
`void`	`minimize()`	Minimiert das Fenster des Java Client
`BStr`	`nextGuid()`	Liefert die `GUID` für das nächste Element des Iterators
`BStr`	`nextName()`	Liefert die Kurzbezeichnung für das nächste Element des Iterators
`Int32`	`nextObjectId()`	Liefert die Objekt Id für das nächste Element des Iterators
`Int32`	`OK()`	Konstante: Alles OK
`void`	`openSelectedDocument()`	Das in der Baumansicht ausgewählte Dokument wird geöffnet und von einem externen Programm angezeigt.
`VariantBool`	`prepareMaskSearch()`	Die Funktion wird aufgerufen wenn eine neue Maskensuche durchgeführt werden soll.
`VariantBool`	`prepareObject(Int32 objectId)`	Wenn ein Archivobjekt (Dokument oder Ordner) bearbeitet werden soll, muss es zunächst mit `IObjectProperties.prepareObject(Int32)` identifiziert werden.
`void`	`printSelectedDocument()`	Das in der Baumansicht ausgewählte Dokument wird gedruckt.
`void`	`reactivate()`	Stellt das vor der Deaktivierung angezeigte Dokument wieder in die Dokumentenvorschau.
`VariantBool`	`refreshIntray()`	Lädt die Dateien in der Posbox neu.
`void`	`removeAttachmentOfSelectedDocument()`	Entfernt die Dateianbindung des in der Baumansicht selektierten Dokuments.
`Int32`	`runScriptFunction(BStr functionName, BStr parameters)`	Startet die JavaScript Funktion mit dem angegebenen Namen.
`BStr`	`runScriptFunctionEx(BStr functionName, BStr parameters)`	Wie `IWorkspace.runScriptFunction(BStr, BStr)`, liefert jedoch einen String zurück.
`void`	`scanMultiPage()`	Scannt eine Menge von Seiten.
`void`	`scanSinglePage()`	Scannt eine Menge von Seiten.
`Int32`	`search(BStr searchString)`	Es wird nach einem Objekt mit dem angegebenen Namen (Kurzbezeichnung) gesucht.
`Int32`	`searchByDate(BStr isoDate)`	Sucht nach Dokumenten, die zu dem angegebenen Datum passen oder in dem angegebenen Zeitraum liegen.
`Int32`	`searchByIndex(BStr fieldGroupName, BStr searchString)`	Maskenübergreifende Suche in einem Indexfeld
`Int32`	`searchByMD5Hash(BStr md5Hash)`	Suche nach MD5 Hash.
`Int32`	`searchByNotes(BStr searchString)`	Sucht nach Dokumenten, die eine Haftnotiz mit dem angegebenen Text enthalten.
`Int32`	`searchFulltext(BStr searchString)`	Eine Volltextsuche nach einem Objekt mit dem angegebenen Namen wird durchgeführt.
`Int32`	`searchIds(BStr objectIds, BStr searchViewTitle)`	Die Archivobjekte mit den angegebenen Objekt Ids werden in der Suchansicht angezeigt.
`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 index)`	Selektiert in der Postbox die Zeile mit dem angegebenen Index
`VariantBool`	`sendSelectedDocument(BStr receiverMailAddress)`	Das in der Baumansicht ausgewählte Dokument wird wird an die angegebene E-Mail Adresse gesendet.
`VariantBool`	`setDateInIntray(BStr documentFileName, BStr date)`	Seiteneffekte: Setzt das Dokumentendatum der angegebenen Datei in der Postbox
`VariantBool`	`setDescription(BStr description)`	Setzt den Memo Text für das aktive Archivobjekt.
`VariantBool`	`setIndexField(Int32 fieldId, BStr fieldValue)`	Setzt das Indexfeld mit der angegebnen Id für das aktuelle Archivobjekt.
`VariantBool`	`setIndexFieldInIntray(BStr documentFilePath, Int32 maskId, Int32 fieldId, BStr fieldValue)`	Seiteneffekte: Setzt ein Indexfeld eines Dokuments in der Postbox.
`VariantBool`	`setMaskFieldValue(BStr maskFieldName, BStr maskFieldValue)`	Setzt ein Maskenfeld der Suchmaske auf einen bestimmten Wert.
`VariantBool`	`setMaskId(Int32 maskId)`	Für die Suche wird die Maske mit der angegebenen Masken Id verwendet.
`VariantBool`	`setMaskName(BStr maskName)`	Für die Suche wird die Maske mit dem angegebenen Maskennamen verwendet.
`VariantBool`	`setName(BStr name)`	Setzt den Namen bzw. die Kurzbezeichnung des aktuellen Archivobjekts.
`VariantBool`	`setNameInIntray(BStr documentFileName, BStr name)`	Seiteneffekte: Setzt die Kurzbezeichnung der angegebenen Datei in der Postbox
`void`	`setObjAcl(BStr aclString)`	Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen.
`VariantBool`	`setObjAcl2(BStr aclString)`	Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen.
`void`	`setReminderCreateDate(BStr createDate)`	Setzt das Erstellungsdatum des selektierten Wiedervorlagetermins
`void`	`setReminderDescription(BStr description)`	Setzt den Beschreibungstext des selektierten Wiedervorlagetermins
`void`	`setReminderName(BStr name)`	Setzt den Namen des Wiedervorlagetermins
`void`	`setReminderPriority(Int32 priority)`	Setzt die Priorität des selektierten Wiedervorlagetermins.
`void`	`setReminderPromptDate(BStr date)`	Setzt den Termin für die Wiedervorlage
`void`	`setReminderReceiverId(Int32 ownerUserId)`	Setzt die Benutzer Id des Empfängers für einen Wiedervorlagetermin
`void`	`setReminderSenderId(Int32 fromUserId)`	Setzt die Benutzer Id des Absenders des selektierten Wiedervorlagetermins
`void`	`setShowIndexDialog(VariantBool showIndexDialog)`	Hier kann die Anzeige des Indexdialogs für die Verschlagwortung global aktiviert/deaktiviert werden.
`void`	`showAppointmentView()`	Im Workspace wird auf die Terminansicht umgeschaltet.
`void`	`showArchiveView()`	Im Workspace wird auf die oberste Archivansicht umgeschaltet.
`void`	`showCheckoutView()`	Im Workspace wird auf die Ansicht In Bearbeitung umgeschaltet.
`void`	`showClipboardView()`	Im Workspace wird auf die Klemmbrett Ansicht umgeschaltet.
`void`	`showId(Int32 id)`	Stellt die Dokumentenvorschau auf eine neue ObjektId ein.
`void`	`showIntrayView()`	Im Workspace wird auf die Postbox Ansicht umgeschaltet.
`void`	`showMyEloView()`	Aktiviert den Programmbereich "Mein ELO".
`VariantBool`	`showSearchDialog()`	Seiteneffekte: Der Suchdialog wird angezeigt
`void`	`showSearchView()`	Im Workspace wird auf die oberste Suchansicht umgeschaltet.
`Int32`	`sortSearchList(Int32 column, Int32 mode)`	Sortiert die Liste/Tabelle mit den Suchergebnissen
`void`	`startFunction(Int32 functionID)`	Deprecated. Diese Funktion verstößt gegen das Konzept des Information Hiding, und sollte nicht aufgerufen werden
`void`	`startFunction(BStr functionName)`	Die Funktion mit dem angegebenen Funktionsbezeichnung wird ausgeführt
`void`	`startInstall(BStr importUrl)`	Startet den Download und Import des Installationspakets aus der URL.
`Int32`	`switchToArchive(BStr archiveName)`	Seiteneffekte: Der Benutzer wird an dem Archiv mit dem angegebenen Namen angemeldet.
`void`	`toFront()`	Bringt das Fenster des Java Clients in den Vordergrund
`void`	`unselectAllIntrayRows()`	Die Auswahl von Zeilen/Dateien in der Postbox wird aufgehoben
`void`	`updateKeywords()`	Löscht alle Keyworlisten aus dem Keywordcache.
`void`	`updateMasks()`	Löscht alle Masken aus dem Maskencache.
`void`	`updateUsers()`	Löscht alle Benutzer aus dem Cache.
`VariantBool`	`userIdExists(Int32 userId)`	Liefert True, falls ein Benutzer mit der angegebenen Benutzer Id existiert.
`VariantBool`	`userNameExists(BStr userName)`	Liefert `True`, falls ein Benutzer mit dem angegebenen Benutzernamen existiert.

Methods inherited from class DispatchComServer

release

Methods inherited from class IDispatchServer

a, getIDsOfNames, getTypeInfo, getTypeInfoCount, invoke, isDispInterface, isUseCaseSensitiveNameComparison, registerMethods, registerMethods, setDispInterface, setUseCaseSensitiveNameComparison

Methods inherited from class IUnknownServer

a, addRef, addRefAggregated, create, doQueryInterface, getClassImpl, getRefCount, h, isAutoDelete, isNull, queryInterface, queryInterfaceAggregated, releaseAggregated, setAutoDelete, setNull

Methods inherited from class Object

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

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
- COM_SERVER_CLSID
  
  public static final CLSID COM_SERVER_CLSID
  
  KlassenId des COM-Servers
- PROG_ID
  
  public static final String PROG_ID
  
  Programm-ID
  
  See Also:
  
  Constant Field Values
- VERSION_INDEPENDENT_PROG_ID
  
  public static final String VERSION_INDEPENDENT_PROG_ID
  
  Unabhängige Programm-ID
  
  See Also:
  
  Constant Field Values
- COM_SERVER_DESCRIPTION
  
  public static final String COM_SERVER_DESCRIPTION
  
  Programmbezeichnung
  
  See Also:
  
  Constant Field Values
Constructor Details
- EloComServer
  
  public EloComServer(CoClassMetaInfo classImpl)
  
  Konstruktor.
  
  Parameters:
  
  classImpl - Metainformationen
Method Details
- destroy
  
  public void destroy()
  
  Overrides:
  
  destroy in class IUnknownServer
- doDestroy
  
  public void doDestroy()
  
  Overrides:
  
  doDestroy in class IUnknownServer
- getClassID
  
  public void getClassID(CLSID pClassID) throws ComException
  
  This method retrieves the class identifier (CLSID) of an object.
  
  Specified by:
  
  getClassID in interface IPersist
  
  Parameters:
  
  pClassID - the class identifier (CLSID) of an object
  
  Throws:
  
  ComException
- getProgId
  
  public BStr getProgId()
  
  Liefert die Programm-Id zurück.
  
  Returns:
  
  Programm-Id
- getVersionIndependentProgId
  
  public BStr getVersionIndependentProgId()
  
  Liefert die versionsunabhängige Programm-Id zurück.
  
  Returns:
  
  Programm-Id
- getComServerDescription
  
  public BStr getComServerDescription()
  
  Liefert die COM Server-Beschreibung zurück.
  
  Returns:
  
  COM Server Beschreibung
- login2
  
  public Int32 login2(BStr archiveName, BStr archivePath, BStr userName, BStr userPassword)
  
  Description copied from interface: IWorkspace
  Die Login-Methode authentifiziert einen Benutzer für den Zugriff auf ein Archiv.
  
  Vorbedingung: Das angegebene Archiv existiert und der Archivpfad ist korrekt angegeben. Der Benutzername ist in Elo vorhanden.
  
  Nachbedingung: Der Benutzer ist angemeldet und kann Funktionen ausführen, für die er die notwendigen Rechte besitzt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login "Mein Archiv" "http://testserver:8080/ix-elo/ix" "Benutzername" "Passwort"
  Specified by:
  
  login2 in interface IWorkspace
  
  Parameters:
  
  archiveName - (beliebiger) Name des Archivs
  
  archivePath - Pfad zum Archiv auf dem Indexserver
  
  userName - Benutzername
  
  userPassword - Benutzerpasswort
  
  Returns:
  
  0 bei bereits aktivem Workspace oder erfolgreichem Login, -1 sonst
- loginWithDialog
  
  public VariantBool loginWithDialog()
  
  Description copied from interface: IWorkspace
  Startet den Login Dialog. Der Benutzer kann sich jetzt mit seinem Benutzernamen und Passwort anmelden. Diese Methode sollte zu Beginn und vor allen anderen Methoden aufgerufen werden. Der Aufruf der Methode blockiert den Programmfluss so lange bis die Verbindung hergestellt ist, d. h. der Workspace geöffnet wurde oder der Benutzer auf Abbrechen geklickt hat.
  
  Vorbedingung: keine
  
  Nachbedingung: Wenn in der Registry noch kein Archiv eingetragen ist wird ein Konfigurationsdialog angezeigt. Der Benutzer kann jetzt einen Archivnamen und einen Archivpfad angeben. Ansonsten wird der Login Dialog angezeigt. Der Benutzer kann ein Archiv wählen und sich anmelden. Anschließend kann er die Funktionen ausführen, für die er die nötigen Rechte besitzt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ...
  Specified by:
  
  loginWithDialog in interface IWorkspace
  
  Returns:
  
  VariantBool.TRUE falls die Anmeldung erfolgreich war.
  VariantBool.FALSE falls auf Abbrechen geklickt wurde oder im Fehlerfall
- gotoObjectId
  
  public VariantBool gotoObjectId(Int32 id)
  
  Description copied from interface: IWorkspace
  Der Archivteintrag mit der angegebnen Objekt ID wird im TreeView in der Archivansicht ausgewählt/selektiert. Falls es sich um ein Dokument handelt wird das Dokument in der Dokumentenvorschau angezeigt.
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Ein Objekt mit der angegebenen ID existiert.
  
  Nachbedingung: Der Archivteintrag mit der angegebenen ID wird angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.gotoObjectId 1198436
  Specified by:
  
  gotoObjectId in interface IWorkspace
  
  Parameters:
  
  id - Objekt ID des Archiveintrags
  
  Returns:
  
  TRUE, falls ein Archiveintrag mit der angegebene ID existiert und kein Fehler aufgetreten ist
- gotoGuid
  
  public VariantBool gotoGuid(BStr guid)
  
  Description copied from interface: IWorkspace
  Der Archivteintrag mit der angegebnen GUID wird im TreeView in der Archivansicht ausgewählt/selektiert. Falls es sich um ein Dokument handelt wird das Dokument in der Dokumentenvorschau angezeigt.
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Ein Objekt mit der angegebenen GUID existiert.
  
  Nachbedingung: Der Archivteintrag mit der angegebenen GUID wird angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.gotoGuid "(BBB9186C-8611-D3A5-B607-4BEDE0ECA16C)"
  Specified by:
  
  gotoGuid in interface IWorkspace
  
  Parameters:
  
  guid - GUID des Archiveintrag
  
  Returns:
  
  TRUE, falls ein Archiveintrag mit der angegebene Id existiert und kein Fehler aufgetreten ist
  
  Since:
  
  8.04.000
- gotoEcd
  
  public VariantBool gotoEcd(BStr filePath)
  
  Description copied from interface: IWorkspace
  Zeigt den Inhalt einer ECD Datei an. Handelt es sich um ein einzelnes Objekt wird dieses in der Archivansicht angezeigt. Sind mehrere Objekte in der ECD Datei verlinkt werden diese in der Suchansicht angezeigt.
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Am angegebenen Pfad existiert eine ECD Datei.
  
  Nachbedingung: Der Archivteintrag mit der angegebenen GUID wird angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.gotoEcd "C:\link.ecd"
  Specified by:
  
  gotoEcd in interface IWorkspace
  
  Parameters:
  
  filePath - Pfad zur ECD Datei
  
  Returns:
  
  TRUE, falls der Verlinkte inhalt aufgerufen werden kann
  
  Since:
  
  9.00.000
- showAppointmentView
  
  public void showAppointmentView()
  
  Description copied from interface: IWorkspace
  Im Workspace wird auf die Terminansicht umgeschaltet.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Die Terminansicht wird angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.showAppointmentView
  Specified by:
  
  showAppointmentView in interface IWorkspace
- showArchiveView
  
  public void showArchiveView()
  
  Description copied from interface: IWorkspace
  Im Workspace wird auf die oberste Archivansicht umgeschaltet.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Die Archivansicht wird angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.showArchiveView
  Specified by:
  
  showArchiveView in interface IWorkspace
- showCheckoutView
  
  public void showCheckoutView()
  
  Description copied from interface: IWorkspace
  Im Workspace wird auf die Ansicht In Bearbeitung umgeschaltet.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Die Ansicht In Bearbeitung wird angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.showCheckoutView
  Specified by:
  
  showCheckoutView in interface IWorkspace
- showClipboardView
  
  public void showClipboardView()
  
  Description copied from interface: IWorkspace
  Im Workspace wird auf die Klemmbrett Ansicht umgeschaltet.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Die Klemmbrett Ansicht wird angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.showClipboardView
  Specified by:
  
  showClipboardView in interface IWorkspace
- showIntrayView
  
  public void showIntrayView()
  
  Description copied from interface: IWorkspace
  Im Workspace wird auf die Postbox Ansicht umgeschaltet.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Die Postbox Ansicht wird angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.showIntrayView
  Specified by:
  
  showIntrayView in interface IWorkspace
- showSearchView
  
  public void showSearchView()
  
  Description copied from interface: IWorkspace
  Im Workspace wird auf die oberste Suchansicht umgeschaltet.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Eine der folgenden Methoden wurde ausgeführt:
  
  ISearch.search(BStr)
  ISearch.searchByDate(BStr)
  ISearch.searchByNotes(BStr)
  ISearch.searchFulltext(BStr)
  
  Nachbedingung: Die oberste Suchansicht wird angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.showSearchView
  Specified by:
  
  showSearchView in interface IWorkspace
- showMyEloView
  
  public void showMyEloView()
  
  Aktiviert den Programmbereich "Mein ELO".
  
  Specified by:
  
  showMyEloView in interface IWorkspace
  
  Since:
  
  9.02.000
- startFunction
  
  public void startFunction(Int32 functionID)
  
  Deprecated.
  Diese Funktion verstößt gegen das Konzept des Information Hiding, und sollte nicht aufgerufen werden
  
  Description copied from interface: IWorkspace
  Die Funktion mit der angegebenen Funktions ID wird ausgeführt
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Der Benutzer verfügt über die Berechtigung, die Funktion auszuführen.
  
  Nachbedingung: Die Funktion mit der angegebenen Funktions ID wurde ausgeführt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.startFunction 44
  Specified by:
  
  startFunction in interface IWorkspace
  
  Parameters:
  
  functionID - Funktionsnummer
  
  See Also:
  
  Fct
- startFunction
  
  public void startFunction(BStr functionName)
  
  Description copied from interface: IWorkspace
  Die Funktion mit dem angegebenen Funktionsbezeichnung wird ausgeführt
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Der Benutzer verfügt über die Berechtigung, die Funktion auszuführen.
  
  Nachbedingung: Die Funktion mit der angegebenen Funktionsbezeichnung wurde ausgeführt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.startFunction IndexDialog
  Specified by:
  
  startFunction in interface IWorkspace
  
  Parameters:
  
  functionName - Funktionsname
  
  Since:
  
  7.00.008
  
  See Also:
  
  Fct
- updateKeywords
  
  public void updateKeywords()
  
  Description copied from interface: IWorkspace
  Löscht alle Keyworlisten aus dem Keywordcache. Dieses wird z.B. notwendig, wenn lokal die Liste verändert wurde, andernfalls werden diese Änderungen lokal nicht sichtbar. Gelöschte Einträge werden beim nächsten Aufruf automatisch neu vom Server geladen.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Der Benutzer verfügt über die Berechtigung, die Funktion auszuführen.
  
  Nachbedingung: Die Keywordlisten wurden aus dem Keywordcache gelöscht.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.updateKeywords
  Specified by:
  
  updateKeywords in interface IWorkspace
- updateMasks
  
  public void updateMasks()
  
  Description copied from interface: IWorkspace
  Löscht alle Masken aus dem Maskencache. Dieses wird z.B. notwendig, wenn lokal die Maskendefinition verändert wurde, andernfalls werden diese Änderungen lokal nicht sichtbar. Gelöschte Einträge werden beim nächsten Aufruf automatisch neu vom Server geladen.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Der Benutzer verfügt über die Berechtigung, die Funktion auszuführen.
  
  Nachbedingung: Alle Masken wurden aus dem Maskencache gelöscht.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.updateMasks
  Specified by:
  
  updateMasks in interface IWorkspace
- updateUsers
  
  public void updateUsers()
  
  Description copied from interface: IWorkspace
  Löscht alle Benutzer aus dem Cache.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Der Benutzer verfügt über die Berechtigung, die Funktion auszuführen.
  
  Nachbedingung: Alle Benutzer wurden aus dem Cache gelöscht.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.updateUsers
  Specified by:
  
  updateUsers in interface IWorkspace
- switchToArchive
  
  public Int32 switchToArchive(BStr archiveName)
  
  Description copied from interface: IWorkspace
  Seiteneffekte: Der Benutzer wird an dem Archiv mit dem angegebenen Namen angemeldet. Der Benutzername und das Passwort werden dabei beibehalten. Ein neuer Workspace wird geöffnet. Der Workspace mit dem bisherigen Archiv wird nicht geschlossen.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Der Benutzer verfügt über die Berechtigung, die Funktion auszuführen. Der Benutzer hat einen Benutzeraccount für ein anderes Archiv. Der Benutzername und das Passwort sind dabei identisch.
  
  Nachbedingung: Der Benutzer ist an dem angebenen Archiv angemeldet. Ein neuer Workspace wurde geöffnet.
  
  Fehlerbehandlung: Im Fehlerfall wird einer der unten angegebenen Fehlercodes zurückgeliefert.
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Result = Elo.switchToArchive "FeldWaldUndWiesen Archiv" If (Result = Elo.COULD_NOT_CONNECT()) Then MsgBox "Could not connect" Exit Sub ElseIf (Result = Elo.ARCHIVE_NOT_FOUND()) Then MsgBox "Archive not found" Exit Sub ElseIf (Result = Elo.EXCEPTION()) Then MsgBox "Exception" Exit Sub End If
  Specified by:
  
  switchToArchive in interface IWorkspace
  
  Parameters:
  
  archiveName - Profilname
  
  Returns:
  
  OK, falls der Wechsel funktioniert hat
  
  ARCHIVE_NOT_FOUND, falls der Archivname nicht in der Registry vorhanden ist
  
  COULD_NOT_CONNECT, falls die Verbindung fehlschlägt
  
  EXCEPTION, falls ein anderer Fehler aufgetreten ist
- getArchiveName
  
  public BStr getArchiveName()
  
  Description copied from interface: IWorkspace
  Liefert den Archivnamen des aktiven Archivs.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Der Benutzer verfügt über die Berechtigung, die Funktion auszuführen.
  
  Nachbedingung: Der Archivname wurde zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... name = Elo.getArchiveName
  Specified by:
  
  getArchiveName in interface IWorkspace
  
  Returns:
  
  Profilname
- getArchiveLocation
  
  public BStr getArchiveLocation()
  
  Description copied from interface: IWorkspace
  Liefert den Archivpfad des aktiven Archivs. Der Archivpfad ist eine URL, welche den Servernamen und -port und das Verzeichnis des Archivs enthält.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Der Benutzer verfügt über die Berechtigung, die Funktion auszuführen.
  
  Nachbedingung: Der Archivpfad wurde zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... location = Elo.getArchiveLocation
  Specified by:
  
  getArchiveLocation in interface IWorkspace
  
  Returns:
  
  IX Url
- getDelimiter
  
  public BStr getDelimiter()
  
  Description copied from interface: IWorkspace
  Das Trennzeichen für Arrays, die in Strings kodiert werden.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Das Trennzeichen wird zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... delimiter = Elo.getDelimiter
  Specified by:
  
  getDelimiter in interface IWorkspace
  
  Returns:
  
  Trennzeichen
- minimize
  
  public void minimize()
  
  Description copied from interface: IWorkspace
  Minimiert das Fenster des Java Client
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Die Darstellung des Java Client ist minimiert
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.minimize
  Specified by:
  
  minimize in interface IWorkspace
- getActiveView
  
  public Int32 getActiveView()
  
  Description copied from interface: IWorkspace
  Liefert den Code für die momentan aktive Ansicht
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Der Code für die momentan aktive Ansicht wird zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... view = Elo.getActiveView
  Specified by:
  
  getActiveView in interface IWorkspace
  
  Returns:
  
  Code für die momentan aktive Ansicht:
  
  0 (keine Ansicht)
  1 Archivansicht
  2 Postbox
  3 Klemmbrett
  4 Aufgaben
  5 In Bearbeitung
  6 Suche
  7 Mein ELO
  
  See Also:
  
  NavigationBar.NO_VIEW_TYPE, NavigationBar.ARCHIVE_VIEW_TYPE, NavigationBar.INTRAY_VIEW_TYPE, NavigationBar.CLIPBOARD_VIEW_TYPE, NavigationBar.SEARCH_VIEW_TYPE, NavigationBar.CHECKOUT_VIEW_TYPE, NavigationBar.APPOINTMENT_VIEW_TYPE, NavigationBar.MY_ELO_VIEW_TYPE
- toFront
  
  public void toFront()
  
  Description copied from interface: IWorkspace
  Bringt das Fenster des Java Clients in den Vordergrund
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Das Fenster des Java Clients ist im Vordergrund
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.toFront
  Specified by:
  
  toFront in interface IWorkspace
- runScriptFunction
  
  public Int32 runScriptFunction(BStr functionName, BStr parameters)
  
  Description copied from interface: IWorkspace
  
  Startet die JavaScript Funktion mit dem angegebenen Namen.
  
  Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv. Im Archiv existiert ein Javascript, welches eine Funktion mit dem angegebenen Namen enthält. Der Funktionsname muss das Präfix "eloCom" enthalten.
  
  Nachbedingung: Die Funktion wurde ausgeführt.
  
  Fehlerbehandlung: Im Fehlerfall wird ein Fehlercode zurückgeliefert (s.u.).
  Specified by:
  
  runScriptFunction in interface IWorkspace
  
  Parameters:
  
  functionName - Der Funktionsname muss das Präfix "eloCom" enthalten.
  
  parameters - Verschiedene Parameter, getrennt durch ¶.
  
  Kein Parameter: Leerstring
  Ein Parameter: Wort
  Mehrere Parameter: "Eins¶Zwei¶Drei"
  
  Returns:
  
  -101: Script nicht gefunden
  -102: Fehler im Script (Exception)
  -103: Unspezifischer Fehler, z. B. bei der Validierung (eloCom)
  Sonst: Return-Wert der JavaScript Funktion. Achtung: Es sind nur positive Zahlen als Rückgabewerte möglich.
  
  Since:
  
  8.01.000
- runScriptFunctionEx
  
  public BStr runScriptFunctionEx(BStr functionName, BStr parameters)
  
  Description copied from interface: IWorkspace
  
  Wie IWorkspace.runScriptFunction(BStr, BStr), liefert jedoch einen String zurück.
  Specified by:
  
  runScriptFunctionEx in interface IWorkspace
  
  Parameters:
  
  functionName - Der Funktionsname muss das Präfix "eloCom" enthalten.
  
  parameters - Verschiedene Parameter, getrennt durch ¶.
  
  Kein Parameter: Leerstring
  Ein Parameter: Wort
  Mehrere Parameter: "Eins¶Zwei¶Drei"
  
  Returns:
  
  Rückgabewert der Scriptfunktion
  
  See Also:
  
  IWorkspace.runScriptFunction(BStr, BStr)
- getVersion
  
  public BStr getVersion()
  
  Description copied from interface: IWorkspace
  
  Liefert die aktuelle Versionsnummer des Java Clients.
  
  Specified by:
  
  getVersion in interface IWorkspace
  
  Returns:
  
  Versionsnummer
- ARCHIVE_NOT_FOUND
  
  public Int32 ARCHIVE_NOT_FOUND()
  
  Description copied from interface: IWorkspace
  
  Konstante: Das Archiv wurde nicht gefunden
  
  Specified by:
  
  ARCHIVE_NOT_FOUND in interface IWorkspace
  
  Returns:
  
  Konstante
- COULD_NOT_CONNECT
  
  public Int32 COULD_NOT_CONNECT()
  
  Description copied from interface: IWorkspace
  
  Konstante: Verbindungsfehler
  
  Specified by:
  
  COULD_NOT_CONNECT in interface IWorkspace
  
  Returns:
  
  Konstante
- EXCEPTION
  
  public Int32 EXCEPTION()
  
  Description copied from interface: IWorkspace
  
  Konstante: Eine Exception ist aufgetreten
  
  Specified by:
  
  EXCEPTION in interface IWorkspace
  
  Returns:
  
  Konstante
- OK
  
  public Int32 OK()
  
  Description copied from interface: IWorkspace
  
  Konstante: Alles OK
  
  Specified by:
  
  OK in interface IWorkspace
  
  Returns:
  
  Konstante
- clear
  
  public void clear()
  
  Description copied from interface: IPreview
  Löscht die aktuelle Dokumentenvorschau und zeigt die Meldung "Kein Dokument zur Ansicht ausgewählt." an.
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Die aktuelle Dokumentenvorschau wurde gelöscht. Die Meldung "Kein Dokument zur Ansicht ausgewählt." wird angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.clear
  Specified by:
  
  clear in interface IPreview
- deactivate
  
  public void deactivate()
  
  Description copied from interface: IPreview
  Löscht die aktuelle Dokumentenvorschau und zeigt die Meldung "Dokument extern geöffnet, Preview deaktiviert." an.
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Die Dokumentenvorschau ist gelöscht und zeigt die Meldung "Dokument extern geöffnet, Preview deaktiviert." an.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.deactivate
  Specified by:
  
  deactivate in interface IPreview
- reactivate
  
  public void reactivate()
  
  Description copied from interface: IPreview
  Stellt das vor der Deaktivierung angezeigte Dokument wieder in die Dokumentenvorschau.
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Die Methode deactivate() wurde aufgerufen.
  
  Nachbedingung: Das vor der Deaktivierung angezeigte Dokument wird in der Dokumentenvorschau angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.showId 12345 Elo.deactivate ... ... Elo.reactivate
  Specified by:
  
  reactivate in interface IPreview
- showId
  
  public void showId(Int32 id)
  
  Description copied from interface: IPreview
  Stellt die Dokumentenvorschau auf eine neue ObjektId ein. Das Sord Objekt wird dann vom Indexserver gelesen und die Verschlagwortungsvorschau und die Dokumentenanzeige aktualisiert.
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Das Objekt mit der angegebenen ID wird angezeigt, falls vorhanden.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.showId 1198436
  Specified by:
  
  showId in interface IPreview
  
  Parameters:
  
  id - Objekt Id des Sord Objekts
- displayLocalFile
  
  public void displayLocalFile(BStr fileName)
  
  Description copied from interface: IPreview
  Stellt die Dokumentenvorschau auf eine lokale Datei, z.B. aus der Postbox ein. Es wird geprüft, ob es zu dieser Datei eine ESW Verschlagwortungsdatei gibt, diese wird dann mit eingelesen und im Dokumentenvorschau Fenster angezeigt.
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv.
  
  Nachbedingung: Die Datei mit dem angegebenen Pfad wird angezeigt, falls vorhanden.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.displayLocalFile "C:/foo/bar/test.txt"
  Specified by:
  
  displayLocalFile in interface IPreview
  
  Parameters:
  
  fileName - Pfad der Datei die angezeigt werden soll
- addAttachmentToSelectedDocument
  
  public VariantBool addAttachmentToSelectedDocument(BStr attachmentFilePath)
  
  Description copied from interface: IDocument
  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"
  Specified by:
  
  addAttachmentToSelectedDocument in interface IDocument
  
  Parameters:
  
  attachmentFilePath - Dateipfad zu der Dateianbindung (Attachment)
  
  Returns:
  
  True, falls keine Exception aufgetreten ist
- checkInSelectedDocument
  
  public void checkInSelectedDocument()
  
  Description copied from interface: IDocument
  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
  Specified by:
  
  checkInSelectedDocument in interface IDocument
- checkOutSelectedDocument
  
  public void checkOutSelectedDocument()
  
  Description copied from interface: IDocument
  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
  Specified by:
  
  checkOutSelectedDocument in interface IDocument
- checkOutDocument
  
  public BStr checkOutDocument(Int32 documentId)
  
  Description copied from interface: IDocument
  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)
  Specified by:
  
  checkOutDocument in interface IDocument
  
  Parameters:
  
  documentId - Objekt Id des Archivobjekts
  
  Returns:
  
  Dateipfad des ausgecheckten Dokuments
- openSelectedDocument
  
  public void openSelectedDocument()
  
  Description copied from interface: IDocument
  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
  Specified by:
  
  openSelectedDocument in interface IDocument
- printSelectedDocument
  
  public void printSelectedDocument()
  
  Description copied from interface: IDocument
  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
  Specified by:
  
  printSelectedDocument in interface IDocument
- sendSelectedDocument
  
  public VariantBool sendSelectedDocument(BStr receiverMailAddress)
  
  Description copied from interface: IDocument
  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"
  Specified by:
  
  sendSelectedDocument in interface IDocument
  
  Parameters:
  
  receiverMailAddress - E-Mail Adresse des Empfängers (gemäß RFC 2822)
  
  Returns:
  
  True, falls keine Exception aufgetreten ist
- activateAttachmentOfSelectedDocument
  
  public void activateAttachmentOfSelectedDocument()
  
  Description copied from interface: IDocument
  Ö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
  Specified by:
  
  activateAttachmentOfSelectedDocument in interface IDocument
- getSelectedDocumentId
  
  public Int32 getSelectedDocumentId()
  
  Description copied from interface: IDocument
  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
  Specified by:
  
  getSelectedDocumentId in interface IDocument
  
  Returns:
  
  Object-Id
- getSelectedDocumentName
  
  public BStr getSelectedDocumentName()
  
  Description copied from interface: IDocument
  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
  Specified by:
  
  getSelectedDocumentName in interface IDocument
  
  Returns:
  
  Kurzbezeichnung
- removeAttachmentOfSelectedDocument
  
  public void removeAttachmentOfSelectedDocument()
  
  Description copied from interface: IDocument
  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
  Specified by:
  
  removeAttachmentOfSelectedDocument in interface IDocument
- checkInDocument
  
  public Int32 checkInDocument(BStr absoluteFilePath, BStr documentDate)
  
  Description copied from interface: IDocument
  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. IDocument.CHECKIN_SUCCESS wurde zurückgeliefert.
  
  Fehlerbehandlung: Falls der Dateipfad nicht auf eine Datei im aktuellen Checkout Verzeichnis verweist wird IDocument.FILE_IS_NOT_IN_CHECKOUT_DIR zurückgeliefert. Falls der Dateipfad ungültig ist bzw. nicht auf eine Datei verweist wird IDocument.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
  Specified by:
  
  checkInDocument in interface IDocument
  
  Parameters:
  
  absoluteFilePath - Gültiger lokaler absoluter Dateipfad einer Datei im aktuellen Checkout Verzeichnis
  
  documentDate - ISO Datum
  
  Returns:
  
  0: IDocument.CHECKIN_SUCCESS
  1: IDocument.CHECKIN_ERROR
  2: IDocument.FILE_IS_NOT_IN_CHECKOUT_DIR
- getFileOrigin
  
  public Int32 getFileOrigin(BStr absoluteFilePath)
  
  Description copied from interface: IDocument
  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 IDocument.UNKNOWN_ORIGIN zurückgeliefert. Falls der Dateipfad ungültig ist wird IDocument.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
  Specified by:
  
  getFileOrigin in interface IDocument
  
  Parameters:
  
  absoluteFilePath - Gültiger lokaler absoluter Dateipfad einer beliebigen (existierenden) Datei
  
  Returns:
  
  0: IDocument.UNKNOWN_ORIGIN
  1: IDocument.CURRENT_CHECKOUT
  2: IDocument.CURRENT_DOC_CACHE
  3: IDocument.CURRENT_INTRAY
  4: IDocument.CURRENT_TEMP
  5: IDocument.FOREIGN_CHECKOUT
  6: IDocument.FOREIGN_DOC_CACHE
  7: IDocument.FOREIGN_INTRAY
  8: IDocument.FOREIGN_TEMP
- createTempCopy
  
  public BStr createTempCopy(Int32 objectId)
  
  Description copied from interface: IDocument
  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
  Specified by:
  
  createTempCopy in interface IDocument
  
  Parameters:
  
  objectId - Objekt Id eines Dokuments im geöffneten Archiv
  
  Returns:
  
  Dateipfad der Kopie im lokalen Temp-Verzeichnis des Archivs
- getMD5Hash
  
  public BStr getMD5Hash(BStr filePath)
  
  Description copied from interface: IDocument
  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")
  Specified by:
  
  getMD5Hash in interface IDocument
  
  Parameters:
  
  filePath - Gültiger Dateipfad
  
  Returns:
  
  MD5 Hashwert
- getLinks
  
  public BStr getLinks(Int32 objectId)
  
  Description copied from interface: IDocument
  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???
  Specified by:
  
  getLinks in interface IDocument
  
  Parameters:
  
  objectId - Objekt Id eines existierenden Archivobjekts
  
  Returns:
  
  Objekt Ids der verlinkten Archivobjekte, getrennt durch ClientConstants.ELO_SEPARATOR
- getAttachmentFilePaths
  
  public BStr getAttachmentFilePaths(Int32 objectId)
  
  Description copied from interface: IDocument
  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>
  Specified by:
  
  getAttachmentFilePaths in interface IDocument
  
  Parameters:
  
  objectId - Objekt Id eines Dokuments im Archiv
  
  Returns:
  
  Pfade der Attachment Dateien
- search
  
  public Int32 search(BStr searchString)
  
  Description copied from interface: ISearch
  Es wird nach einem Objekt mit dem angegebenen Namen (Kurzbezeichnung) gesucht. Eine Suchansicht wird geöffnet. Die Suchergebnisse werden angezeigt.
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
  
  Nachbedingung: Die Suchergebnisse werden angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login hits = Elo.search("foobar")
  Specified by:
  
  search in interface ISearch
  
  Parameters:
  
  searchString - Suchwort
  
  Returns:
  
  Anzahl der Treffer
- searchFulltext
  
  public Int32 searchFulltext(BStr searchString)
  
  Description copied from interface: ISearch
  Eine Volltextsuche nach einem Objekt mit dem angegebenen Namen wird durchgeführt. Eine Suchansicht wird geöffnet. Die Suchergebnisse werden angezeigt.
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
  
  Nachbedingung: Die Suchergebnisse werden angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login hits = Elo.searchFulltext("foobar")
  Specified by:
  
  searchFulltext in interface ISearch
  
  Parameters:
  
  searchString - Suchwort
  
  Returns:
  
  Anzahl der Treffer
- searchByDate
  
  public Int32 searchByDate(BStr isoDate)
  
  Description copied from interface: ISearch
  Sucht nach Dokumenten, die zu dem angegebenen Datum passen oder in dem angegebenen Zeitraum liegen.
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
  
  Nachbedingung: Die Suchergebnisse werden angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login hits = Elo.searchByDate("foobar")
  Specified by:
  
  searchByDate in interface ISearch
  
  Parameters:
  
  isoDate - ISO Suchdatum oder Zeitraum
  
  Returns:
  
  Anzahl der Treffer
- searchByNotes
  
  public Int32 searchByNotes(BStr searchString)
  
  Description copied from interface: ISearch
  Sucht nach Dokumenten, die eine Haftnotiz mit dem angegebenen Text enthalten.
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
  
  Nachbedingung: Die Suchergebnisse werden angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login hits = Elo.searchByNotes("foobar")
  Specified by:
  
  searchByNotes in interface ISearch
  
  Parameters:
  
  searchString - Suchwort
  
  Returns:
  
  Anzahl der Treffer
- sortSearchList
  
  public Int32 sortSearchList(Int32 column, Int32 mode)
  
  Description copied from interface: ISearch
  Sortiert die Liste/Tabelle mit den Suchergebnissen
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Eine Suche wurde ausgeführt. Die Suchliste wird angezeigt.
  
  Nachbedingung: Die Suchergebnisse sind sortiert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.search "foobar" Elo.sortSearchList(1,0)
  Specified by:
  
  sortSearchList in interface ISearch
  
  Parameters:
  
  column - Spalte der Suchliste, die sortiert werden soll. Ab 0 wird gezählt
  
  mode - Sortiermodus: ADD_SORT: 0, REMOVE_SORT: 1, INSERT_SORT: 2
  mode defines whether a column should be added, removed or inserted. ADD_SORT clears sorting columns before adding a column to sort, REMOVE_SORT removes a column from sorting and INSERT_SORT adds a sorting column.
  
  Returns:
  
  0
  
  See Also:
  
  SortTableModel.sort(int, int), SortTableModel.ADD_SORT, SortTableModel.REMOVE_SORT, SortTableModel.INSERT_SORT
- hasNext
  
  public VariantBool hasNext()
  
  Description copied from interface: ISearch
  Liefert VariantBool.TRUE falls das letzte Element des Iterators noch nicht erreicht wurde.
  
  Seiteneffekte: Wenn das letzte Element des Iterators erreicht ist wird die aktive Suchansicht geschlossen. Dadurch wird eine übermäßige Häufung von neu angelegten Suchansichten verhindert.
  
  Vorbedingung: Der Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode angemeldet. Eine der folgenden Methoden wurde ausgeführt:
  
  ISearch.search(BStr)
  ISearch.searchByDate(BStr)
  ISearch.searchByNotes(BStr)
  ISearch.searchFulltext(BStr)
  ISearch.searchByMD5Hash(BStr)
  ISearch.searchIds(BStr,BStr)
  ISearch.commitMaskSearch()
  
  Nachbedingung: Liefert VariantBool.TRUE falls das letzte Element des Iterators noch nicht erreicht wurde. Wenn das letzte Element des Iterators erreicht ist wird die aktive Suchansicht geschlossen und VariantBool.FALSE zurückgeliefert. Dadurch wird eine übermäßige Häufung von neu angelegten Suchansichten verhindert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.search "foobar" while (Elo.hasNext()) MsgBox Elo.nextName() wend
  Specified by:
  
  hasNext in interface ISearch
  
  Returns:
  
  VariantBool.TRUE falls das letzte Element des Iterators noch nicht erreicht wurde.
- nextObjectId
  
  public Int32 nextObjectId()
  
  Description copied from interface: ISearch
  Liefert die Objekt Id für das nächste Element des Iterators
  
  Vorbedingung: Die Methode ISearch.hasNext() wurde aufgerufen und liefert VariantBool.TRUE
  
  Nachbedingung: Liefert die Objekt Id für das nächste Element des Iterators
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.search "foobar" while (Elo.hasNext()) MsgBox Elo.nextObjectId() wend
  Specified by:
  
  nextObjectId in interface ISearch
  
  Returns:
  
  Die Objekt Id für das nächste Element des Iterators
- nextName
  
  public BStr nextName()
  
  Description copied from interface: ISearch
  Liefert die Kurzbezeichnung für das nächste Element des Iterators
  
  Vorbedingung: Die Methode ISearch.hasNext() wurde aufgerufen und liefert VariantBool.TRUE
  
  Nachbedingung: Liefert die Kurzbezeichnung für das nächste Element des Iterators
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.search "foobar" while (Elo.hasNext()) MsgBox Elo.nextName() wend
  Specified by:
  
  nextName in interface ISearch
  
  Returns:
  
  Die Kurzbezeichnung für das nächste Element des Iterators
- nextGuid
  
  public BStr nextGuid()
  
  Description copied from interface: ISearch
  Liefert die GUID für das nächste Element des Iterators
  
  Vorbedingung: Die Methode ISearch.hasNext() wurde aufgerufen und liefert VariantBool.TRUE
  
  Nachbedingung: Liefert die GUID für das nächste Element des Iterators
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.search "foobar" while (Elo.hasNext()) MsgBox Elo.nextGuid() wend
  Specified by:
  
  nextGuid in interface ISearch
  
  Returns:
  
  Die GUID für das nächste Element des Iterators
- showSearchDialog
  
  public VariantBool showSearchDialog()
  
  Description copied from interface: ISearch
  Seiteneffekte: Der Suchdialog wird angezeigt
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
  
  Nachbedingung: Der Suchdialog wird angezeigt. Der Benutzer kann interaktiv eine Suche starten
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.showSearchDialog
  Specified by:
  
  showSearchDialog in interface ISearch
  
  Returns:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- searchIds
  
  public Int32 searchIds(BStr objectIds, BStr searchViewTitle)
  
  Description copied from interface: ISearch
  Die Archivobjekte mit den angegebenen Objekt Ids werden in der Suchansicht angezeigt. Die Anzahl der gefundenen Archivobjekte wird zurückgeliefert.
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
  
  Nachbedingung: Die Suchansicht mit den Suchergebnissen wird angezeigt.
  
  Fehlerbehandlung: Falls eine der Objekt Ids im Archiv nicht existiert ist das entsprechende Archivobjekt nicht in der Ergebnisliste enthalten. Bei anderen Fehlern wird -1 zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... result = Elo.searchIds("1???","Verlinkte Archivobjekte")
  Specified by:
  
  searchIds in interface ISearch
  
  Parameters:
  
  objectIds - Objekt Ids, getrennt durch ELO_SEPARATOR
  
  searchViewTitle - Titel der neu angelegten Suchansicht
  
  Returns:
  
  Anzahl der gefundenen Archivobjekte
- searchByMD5Hash
  
  public Int32 searchByMD5Hash(BStr md5Hash)
  
  Description copied from interface: ISearch
  Suche nach MD5 Hash. Die gefundenen Archivobjekte werden in einer neuen Suchansicht angezeigt. Die Anzahl der gefundenen Archivobjekte wird zurückgeliefert.
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Ein Archivobjekt mit einem Dokument mit dem angegebenen MD5 Hash existiert im Archiv.
  
  Nachbedingung: Die Suchansicht mit den Suchergebnissen wird angezeigt.
  
  Fehlerbehandlung: Im Fehlerfall wird -1 zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... result = Elo.searchByMD5Hash("C4140E6616E2715A32C1AC6EE79672C8")
  Specified by:
  
  searchByMD5Hash in interface ISearch
  
  Parameters:
  
  md5Hash - MD5 Hash
  
  Returns:
  
  Anzahl der Suchergebnisse
- commitMaskSearch
  
  public Int32 commitMaskSearch()
  
  Description copied from interface: ISearch
  Startet die Maskensuche.
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Die Methode ISearch.prepareMaskSearch() wurde aufgerufen.
  
  Nachbedingung: Die Suche wurde ausgeführt. Die Suchergebnisse werden angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareMaskSearch() Elo.setMaskName("EMail") Elo.setMaskFieldValue("Von","Maus") Elo.setMaskFieldValue("An","Klaus") Elo.commitMaskSearch()
  Specified by:
  
  commitMaskSearch in interface ISearch
  
  Returns:
  
  Anzahl der Suchergebnisse oder -1 im Fehlerfall
- setMaskFieldValue
  
  public VariantBool setMaskFieldValue(BStr maskFieldName, BStr maskFieldValue)
  
  Description copied from interface: ISearch
  Setzt ein Maskenfeld der Suchmaske auf einen bestimmten Wert.
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Die Methode ISearch.prepareMaskSearch() wurde aufgerufen. Die Methode ISearch.setMaskId(Int32) oder ISearch.setMaskName(BStr) wurde aufgerufen.
  
  Nachbedingung: Die Suche wird auf den Wert des angegebenen Maskenfelds eingeschränkt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareMaskSearch() Elo.setMaskName("EMail") Elo.setMaskFieldValue("Von","Maus") Elo.setMaskFieldValue("An","Klaus") Elo.commitMaskSearch()
  Specified by:
  
  setMaskFieldValue in interface ISearch
  
  Parameters:
  
  maskFieldName - Name des Maskenfeldes
  
  maskFieldValue - Wert des Maskenfeldes
  
  Returns:
  
  VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist
- setMaskName
  
  public VariantBool setMaskName(BStr maskName)
  
  Description copied from interface: ISearch
  Für die Suche wird die Maske mit dem angegebenen Maskennamen verwendet.
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Die Methode ISearch.prepareMaskSearch() wurde aufgerufen.
  
  Nachbedingung: Die Suche wird auf die Maske mit dem angegebenen Maskennamen beschränkt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareMaskSearch() Elo.setMaskName("EMail") Elo.commitMaskSearch()
  Specified by:
  
  setMaskName in interface ISearch
  
  Parameters:
  
  maskName - Name der Maske
  
  Returns:
  
  VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist
- prepareMaskSearch
  
  public VariantBool prepareMaskSearch()
  
  Description copied from interface: ISearch
  Die Funktion wird aufgerufen wenn eine neue Maskensuche durchgeführt werden soll. Die Funktion ist Teil eines transaktionalen Musters (prepare/commit).
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
  
  Nachbedingung: Eine neue Maskensuche ist intitialisiert. Eine der der setMask* -Methoden kann jetzt aufgerufen werden.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareMaskSearch() Elo.setMaskName("EMail") Elo.setMaskFieldValue("Von","Maus") Elo.setMaskFieldValue("An","Klaus") Elo.commitMaskSearch()
  Specified by:
  
  prepareMaskSearch in interface ISearch
  
  Returns:
  
  VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist
  
  See Also:
  
  ISearch.setMaskId(Int32), ISearch.setMaskName(BStr), ISearch.setMaskFieldValue(BStr, BStr), ISearch.commitMaskSearch()
- searchByIndex
  
  public Int32 searchByIndex(BStr fieldGroupName, BStr searchString)
  
  Description copied from interface: ISearch
  Maskenübergreifende Suche in einem Indexfeld
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
  
  Nachbedingung: Die Suche wurde ausgeführt. Die Suchergebnisse werden angezeigt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.searchByIndex "An","Klaus"
  Specified by:
  
  searchByIndex in interface ISearch
  
  Parameters:
  
  fieldGroupName - Indexfeld
  
  searchString - Suchwort
  
  Returns:
  
  Anzahl der Suchergebnisse oder -1 im Fehlerfall
- getSelectedObjectGUID
  
  public BStr getSelectedObjectGUID()
  
  Description copied from interface: IArchivedObject
  Liefert die GUID eines im Archiv/Klemmbrett selektierten Objekts.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.
  
  Nachbedingung: Die GUID des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.
  
  Fehlerbehandlung: Wenn nichts selektiert wurde wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.gotoObjectId 1245753 guid = Elo.getSelectedObjectGUID
  Specified by:
  
  getSelectedObjectGUID in interface IArchivedObject
  
  Returns:
  
  GUID des selektierten Objekts
- getSelectedObjectId
  
  public Int32 getSelectedObjectId()
  
  Description copied from interface: IArchivedObject
  Liefert die Objekt Id eines im Archiv/Klemmbrett selektierten Objekts.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.
  
  Nachbedingung: Die Objekt Id des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.
  
  Fehlerbehandlung: Wenn nichts selektiert wurde wird -1 zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.gotoObjectId 1245753 objectId = Elo.getSelectedObjectId
  Specified by:
  
  getSelectedObjectId in interface IArchivedObject
  
  Returns:
  
  Objekt Id des selektierten Objekts
- getSelectedObjectParentId
  
  public Int32 getSelectedObjectParentId()
  
  Description copied from interface: IArchivedObject
  Liefert die Parent Id eines im Archiv/Klemmbrett selektierten Objekts.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.
  
  Nachbedingung: Die Parent Id des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.
  
  Fehlerbehandlung: Wenn nichts selektiert wurde wird -1 zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.gotoObjectId 1245753 objectId = Elo.getSelectedObjectParentId
  Specified by:
  
  getSelectedObjectParentId in interface IArchivedObject
  
  Returns:
  
  Parent Id des selektierten Objekts
- getSelectedObjectName
  
  public BStr getSelectedObjectName()
  
  Description copied from interface: IArchivedObject
  Liefert die Kurzbezeichnung eines im Archiv/Klemmbrett selektierten Objekts.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.
  
  Nachbedingung: Die Kurzbezeichnung des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.
  
  Fehlerbehandlung: Wenn nichts selektiert wurde wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.gotoObjectId 1245753 name = Elo.getSelectedObjectName
  Specified by:
  
  getSelectedObjectName in interface IArchivedObject
  
  Returns:
  
  Name des selektierten Objekts
- getSelectedObjectType
  
  public Int32 getSelectedObjectType()
  
  Description copied from interface: IArchivedObject
  Liefert den Typ eines im Archiv/Klemmbrett selektierten Objekts.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.
  
  Nachbedingung: Der Typ des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.
  
  Fehlerbehandlung: Wenn nichts selektiert wurde wird -1 zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.gotoObjectId 1245753 type = Elo.getSelectedObjectType
  Specified by:
  
  getSelectedObjectType in interface IArchivedObject
  
  Returns:
  
  Typ des selektierten Objekts
- getSelectedObjectChildCount
  
  public Int32 getSelectedObjectChildCount()
  
  Description copied from interface: IArchivedObject
  Liefert die Anzahl der Kindknoten eines im Archiv/Klemmbrett selektierten Objekts. Bei Dokumenten ist dieser Wert Null.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.
  
  Nachbedingung: Die Anzahl der Kindknoten des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.gotoObjectId 1245753 childCount = Elo.getSelectedObjectChildCount
  Specified by:
  
  getSelectedObjectChildCount in interface IArchivedObject
  
  Returns:
  
  Anzahl der Kindknoten des selektierten Objekts
- getSelectedObjectInternalIsoDate
  
  public BStr getSelectedObjectInternalIsoDate()
  
  Description copied from interface: IArchivedObject
  Liefert das interne Datum (Ablagedatum) für ein selektiertes ArchivObjekt.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.
  
  Nachbedingung: Das interne Datum (Ablagedatum) für das selektierte ArchivObjekt wird zurückgegeben.
  
  Fehlerbehandlung: Wenn nichts selektiert wurde wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.gotoObjectId 1245753 internalDate = Elo.getSelectedObjectInternalIsoDate
  Specified by:
  
  getSelectedObjectInternalIsoDate in interface IArchivedObject
  
  Returns:
  
  Das interne Datum (Ablagedatum) für ein selektiertes ArchivObjekt
- getSelectedObjectExternalIsoDate
  
  public BStr getSelectedObjectExternalIsoDate()
  
  Description copied from interface: IArchivedObject
  Liefert das externe Datum (Dokumentendatum) für ein selektiertes ArchivObjekt.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.
  
  Nachbedingung: Das externe Datum (Dokumentendatum) für das selektiertes ArchivObjekt wird zurückgegeben.
  
  Fehlerbehandlung: Wenn nichts selektiert wurde wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.gotoObjectId 1245753 externalDate = Elo.getSelectedObjectExternalIsoDate
  Specified by:
  
  getSelectedObjectExternalIsoDate in interface IArchivedObject
  
  Returns:
  
  Das externe Datum (Dokumentendatum) für ein selektiertes ArchivObjekt
- chooseTargetObject
  
  public Int32 chooseTargetObject(Int32 mode, BStr dialogTitle)
  
  Description copied from interface: IArchivedObject
  Der TreeSelectDialog wird angezeigt. Hier kann der Benutzer ein Archivobjekt auswählen. Die Objekt Id des gewählten Archivobjekts wird zurückgegeben.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Der Parameter mode hat einen der unten angegebenen Werte.
  
  Nachbedingung: Die Objekt Id des gewählten Archivobjekts wird zurückgegeben. Falls der Benutzer auf Abbrechen geklickt hat wird -1 zurückgegeben.
  
  Fehlerbehandlung: Im Fehlerfall wird -1 zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... objectId = Elo.chooseTargetObject(3,"Balu der Bär")
  Specified by:
  
  chooseTargetObject in interface IArchivedObject
  
  Parameters:
  
  mode - Auswahl:
  
  1: Nur Ordner
  2: Nur Dokumente
  3: Dokumente und Ordner
  
  dialogTitle - Fenstertitel des Auswahldialogs
  
  Returns:
  
  Objekt Id des gewählten Archivobjekts oder -1
  
  See Also:
  
  TreeSelectDialog.SELECT_ALLOW_STRUCTURE, TreeSelectDialog.SELECT_ALLOW_DOCUMENTS, TreeSelectDialog.SELECT_ALLOW_ALL
- getObjectTreePath
  
  public BStr getObjectTreePath(Int32 objectId)
  
  Description copied from interface: IArchivedObject
  Liefert den Pfad des Archivobjekts im Archivbaum. Das Archivobjekt wird über die Objekt Id identifiziert. Der Archivpfad enthält ClientConstants.ELO_SEPARATOR als Trennzeichen.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Die Objekt Id eines existierenden Archivobjekts wird angegeben.
  
  Nachbedingung: Der Archivpfad des Archivobjekts wird zurückgegeben.
  
  Fehlerbehandlung: Falls zu der angegebenen Objekt Id kein Archivobjekt existiert wird ein leerer String zurückgeliefert. Falls ein anderer Fehler auftritt wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... objectTreePath = Elo.getObjectTreePath(32)
  Specified by:
  
  getObjectTreePath in interface IArchivedObject
  
  Parameters:
  
  objectId - ObjektId
  
  Returns:
  
  Der Archivpfad des Archivobjekts, Pfadelemente getrennt durch ClientConstants.ELO_SEPARATOR
- archivePathExists
  
  public VariantBool archivePathExists(BStr archivePath)
  
  Description copied from interface: IArchivedObject
  VariantBool.TRUE, falls der angegebene Archivpfad im aktuell geöffneten Archiv vorhanden ist.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet.
  
  Nachbedingung: Falls der angegebene Archivpfad im aktuell geöffneten Archiv vorhanden ist wurde VariantBool.TRUE zurückgeliefert
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... exists = Elo.archivePathExists("Testdateien¶MSG¶Foobar")
  Specified by:
  
  archivePathExists in interface IArchivedObject
  
  Parameters:
  
  archivePath - Archivpfad. Der Archivpfad enthält nicht den Wurzelknoten mit dem Namen des Archivs. Der Archivpfad wird durch ClientConstants.ELO_SEPARATOR getrennt.
  
  Returns:
  
  VariantBool.TRUE, falls der angegebene Archivpfad im aktuell geöffneten Archiv vorhanden ist.
- getIdFromArchivePath
  
  public Int32 getIdFromArchivePath(BStr archivePath)
  
  Description copied from interface: IArchivedObject
  Liefert die Objekt Id eines Archivobjekts, welches über den angegebenen Archivpfad identifiziert wird.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet.
  
  Nachbedingung: Falls der angegebene Archivpfad im aktuell geöffneten Archiv vorhanden ist wird die Objekt Id des letzten Pfadobjekts zurückgeliefert.
  
  Fehlerbehandlung: Wenn der Pfad nicht existiert wird -1 zurückgeliefert. Im Fehlerfall wird -1 zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... id = Elo.getIdFromArchivePath("Testdateien¶MSG¶Foobar")
  Specified by:
  
  getIdFromArchivePath in interface IArchivedObject
  
  Parameters:
  
  archivePath - Archivpfad ohne Archivname, getrennt durch ClientConstants.ELO_SEPARATOR
  
  Returns:
  
  Die Objekt Id des über den Archivpfad identifizierten Archivobjekts
- getSubFolders
  
  public BStr getSubFolders(BStr archivePath)
  
  Description copied from interface: IArchivedObject
  Liefert die Namen der Unterverzeichnisse zu dem angegebenen Archivpfad.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Der angegebene Archivpfad muss im aktuellen Archiv existieren und ein wohlgeformter Archivpfad sein.
  
  Nachbedingung: Die Namen der Unterverzeichnisse/Unterordner werden zurückgeliefert. Falls keine Unterordner existieren wird ein leerer String zurückgeliefert.
  
  Fehlerbehandlung: Im Fehlerfall wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... subFolders = Elo.getSubFolders("Testdateien¶MSG¶Foobar")
  Specified by:
  
  getSubFolders in interface IArchivedObject
  
  Parameters:
  
  archivePath - Archivpfad ohne Archivname, getrennt durch ClientConstants.ELO_SEPARATOR
  
  Returns:
  
  Die Namen der Unterverzeichnisse zu dem angegebenen Archivpfad
- createSubFolder
  
  public VariantBool createSubFolder(BStr archivePath, BStr folderName)
  
  Description copied from interface: IArchivedObject
  Erstellt einen neuen Unterordner unterhalb des angegebenen Archivpfades. Der Archivpfad verweist auf das Parent Objekt. Archivpfade sind leider nicht eindeutig, da mehrere Unterordner eines Ordners den gleichen Namen haben können. In diesem Fall wird irgend ein Objekt ausgewählt.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Ein gültiger Archivpfad archivePath wird angegeben. Der Name des Unterordners folderName ist nicht leer.
  
  Nachbedingung: Der angegebene Unterordner wurde unterhalb des angegebenen Archivpfads eingefügt. Die Anzeige wurde aktualisiert.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... success1 = Elo.createSubFolder("Testdateien¶MSG¶Foobar","FolderName") success2 = Elo.createSubFolder("","FolderName")
  Specified by:
  
  createSubFolder in interface IArchivedObject
  
  Parameters:
  
  archivePath - Archivpfad ohne Archivnamen, getrennt durch ClientConstants.ELO_SEPARATOR. Wenn der Archivpfad leer ist dann wird der Unterordner unter dem Wurzelknoten eingefügt.
  
  folderName - Name des Unterordners. Darf nicht leer sein
  
  Returns:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- makeLink
  
  public VariantBool makeLink(Int32 sourceObjectId, Int32 destinationObjectId)
  
  Description copied from interface: IArchivedObject
  Seiteneffekte: Verlinkt das Quellobjekt (Source) mit dem Zielobjekt (Destination).
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Das Quellobjekt mit der angegebenen sourceObjectId existiert. Das Zielobjekt mit der angegebenen destinationObjectId existiert.
  
  Nachbedingung: Das Quellobjekt hält einen Link auf das Zielobjekt.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... success = Elo.makeLink(245,23)
  Specified by:
  
  makeLink in interface IArchivedObject
  
  Parameters:
  
  sourceObjectId - Objekt Id des Quellobjekts
  
  destinationObjectId - Objekt Id des Zielobjekts
  
  Returns:
  
  VariantBool.TRUE falls das Verlinken erfolgreich war
- getObjectMaskId
  
  public Int32 getObjectMaskId(Int32 objectId)
  
  Description copied from interface: IArchivedObject
  Liefert die Masken Id des Archivobjekts mit der angegebenen Objekt Id
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Das Archivobjekt mit der angegebenen Objekt Id existiert im aktuell geöffneten Archiv.
  
  Nachbedingung: Die Masken Id des Archivobjekts mit der angegebenen Objekt Id wird zurückgeliefert
  
  Fehlerbehandlung: Im Fehlerfall wird -1 zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... maskId = Elo.getObjectMaskId(23)
  Specified by:
  
  getObjectMaskId in interface IArchivedObject
  
  Parameters:
  
  objectId - Objekt Id eines Archivobjekts
  
  Returns:
  
  Masken Id des Archivobjekts
- createReference
  
  public VariantBool createReference(Int32 objectId, Int32 newParentId)
  
  Description copied from interface: IArchivedObject
  Erzeugt eine Referenz für ein Archivobjekt in einem Archivordner.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Das Archivobjekt mit Objekt Id objectId existiert im aktuell geöffneten Archiv. Das Archivobjekt mit der Objekt Id newParentId ist ein Archivordner im aktuell geöffneten Archiv.
  
  Nachbedingung: Eine Referenz auf das angegebene Archivobjekt wurde im angegebenen Archivordner angelegt.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... success = Elo.createReference(123,456)
  Specified by:
  
  createReference in interface IArchivedObject
  
  Parameters:
  
  objectId - Objekt Id des Archivobjekts, welches referenziert werden soll
  
  newParentId - Objekt Id des Archivordners welche die Referenz enthalten soll
  
  Returns:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- getUserNameEx
  
  public BStr getUserNameEx(Int32 userId)
  
  Description copied from interface: IUser
  Liefert den Benutzernamen zu einer existierenden Benutzer Id.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet. Der Benutzer mit der angegebenen Benutzer Id existiert.
  
  Nachbedingung: Der Benutzername zu der angegebenen Benutzer Id wird zurückgeliefert.
  
  Fehlerbehandlung: Falls die angegebene Benutzer Id nicht existiert wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login userName = Elo.getUserName(0)
  Specified by:
  
  getUserNameEx in interface IUser
  
  Parameters:
  
  userId - Id eines existierenden Benutzers
  
  Returns:
  
  Benutzername
- userNameExists
  
  public VariantBool userNameExists(BStr userName)
  
  Description copied from interface: IUser
  Liefert True, falls ein Benutzer mit dem angegebenen Benutzernamen existiert.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.
  
  Nachbedingung: True wird zurückgegeben, falls ein Benutzer mit dem angegebenen Benutzernamen existiert. Andernfalls False.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login if Elo.userNameExists("Blaubarschbube") then doSomething end if
  Specified by:
  
  userNameExists in interface IUser
  
  Parameters:
  
  userName - Benutzername eines existierenden Benutzers
  
  Returns:
  
  True, falls ein Benutzer mit dem angegebenen Benutzernamen existiert.
- userIdExists
  
  public VariantBool userIdExists(Int32 userId)
  
  Description copied from interface: IUser
  Liefert True, falls ein Benutzer mit der angegebenen Benutzer Id existiert.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.
  
  Nachbedingung: True wird zurückgegeben, falls ein Benutzer mit der angegebenen Benutzer Id existert. Andernfalls False.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login if Elo.userIdExists(0) then doSomething end if
  Specified by:
  
  userIdExists in interface IUser
  
  Parameters:
  
  userId - Id eines existierenden Benutzers
  
  Returns:
  
  True, falls ein Benutzer mit der angegebenen Benutzer Id existiert.
- getUserNames
  
  public BStr getUserNames()
  
  Description copied from interface: IUser
  Liefert alle vorhandenen Benutzernamen in einem String. Als Trennzeichen dient das Absatzzeichen ¶.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.
  
  Nachbedingung: Alle vorhandenen Benutzernamen werden zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login userNames = Elo.getUserNames
  Specified by:
  
  getUserNames in interface IUser
  
  Returns:
  
  Alle Benutzernamen
- getGroupNames
  
  public BStr getGroupNames()
  
  Description copied from interface: IUser
  Liefert alle vorhandenen Gruppennamen in einem String. Als Trennzeichen dient das Absatzzeichen ¶.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.
  
  Nachbedingung: Alle vorhandenen Gruppennamen werden zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login groupNames = Elo.getGroupNames
  Specified by:
  
  getGroupNames in interface IUser
  
  Returns:
  
  Alle Gruppennamen
- getSelectedIntrayFile
  
  public BStr getSelectedIntrayFile()
  
  Description copied from interface: IIntray
  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
  Specified by:
  
  getSelectedIntrayFile in interface IIntray
  
  Returns:
  
  Pfad zur Dokumentendatei
- selectAllIntrayRows
  
  public void selectAllIntrayRows()
  
  Description copied from interface: IIntray
  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
  Specified by:
  
  selectAllIntrayRows in interface IIntray
- selectIntrayRow
  
  public void selectIntrayRow(Int32 index)
  
  Description copied from interface: IIntray
  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
  Specified by:
  
  selectIntrayRow in interface IIntray
  
  Parameters:
  
  index - Index der Zeile die selektiert wird
- unselectAllIntrayRows
  
  public void unselectAllIntrayRows()
  
  Description copied from interface: IIntray
  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
  Specified by:
  
  unselectAllIntrayRows in interface IIntray
- scanSinglePage
  
  public void scanSinglePage()
  
  Description copied from interface: IIntray
  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
  Specified by:
  
  scanSinglePage in interface IIntray
- scanMultiPage
  
  public void scanMultiPage()
  
  Description copied from interface: IIntray
  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
  Specified by:
  
  scanMultiPage in interface IIntray
- getNumberOfIntrayFiles
  
  public Int32 getNumberOfIntrayFiles()
  
  Description copied from interface: IIntray
  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
  Specified by:
  
  getNumberOfIntrayFiles in interface IIntray
  
  Returns:
  
  Die Anzahl der Dateien in der Postbox
- addDocumentFileToArchive
  
  public Int32 addDocumentFileToArchive(BStr absoluteFilePath, BStr documentName, BStr documentDate)
  
  Description copied from interface: IIntray
  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"
  Specified by:
  
  addDocumentFileToArchive in interface IIntray
  
  Parameters:
  
  absoluteFilePath - Quellpfad der Dokumenten Datei
  
  documentName - Kurzbezeichnung
  
  documentDate - Dokumentendatum yyyyMMddHHmmss
  
  Returns:
  
  Objekt Id des neuen Archivdokuments oder -1
- addDocumentFileToParent
  
  public Int32 addDocumentFileToParent(Int32 parentObjectId, BStr absoluteFilePath, BStr documentName, BStr documentDate)
  
  Description copied from interface: IIntray
  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"
  Specified by:
  
  addDocumentFileToParent in interface IIntray
  
  Parameters:
  
  parentObjectId - Objekt Id des im Archivbaum übergeordneten Parent Objekts (Ordner)
  
  absoluteFilePath - Quellpfad der Dokumenten Datei
  
  documentName - Kurzbezeichnung
  
  documentDate - Dokumentendatum yyyyMMddHHmmss
  
  Returns:
  
  Objekt Id des neuen Archivdokuments oder -1
- addDocumentFileToIntray
  
  public BStr addDocumentFileToIntray(BStr absoluteFilePath)
  
  Description copied from interface: IIntray
  Kopiert eine Datei aus dem lokalen Filesystem in die Postbox. Falls zuvor die Methode IIntray.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"
  Specified by:
  
  addDocumentFileToIntray in interface IIntray
  
  Parameters:
  
  absoluteFilePath - Datei aus dem lokalen Filesystem. Darf keine Datei aus dem Postboxverzeichnis sein.
  
  Returns:
  
  Neuer Dateipfad in der Postbox, Leerer String bei Fehler, CANCEL bei Abbruch.
- addDocumentFileToArchivePath
  
  public Int32 addDocumentFileToArchivePath(BStr documentFilePath, BStr documentName, BStr documentDate, BStr archivePath)
  
  Description copied from interface: IIntray
  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"
  Specified by:
  
  addDocumentFileToArchivePath in interface IIntray
  
  Parameters:
  
  documentFilePath - Dateipfad der Dokumenten Datei
  
  documentName - Kurzbezeichnung für das Archiv
  
  documentDate - Dokumentendatum yyyyMMddHHmmss
  
  archivePath - Archivpfad ohne Archivname, getrennt durch ELO_SEPARATOR
  
  Returns:
  
  Objekt Id des neuen Archivdokuments oder -1
- setShowIndexDialog
  
  public void setShowIndexDialog(VariantBool showIndexDialog)
  
  Description copied from interface: IIntray
  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 IIntray.addDocumentFileToArchive(BStr, BStr, BStr), IIntray.addDocumentFileToArchivePath(BStr, BStr, BStr, BStr) und IIntray.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
  Specified by:
  
  setShowIndexDialog in interface IIntray
  
  Parameters:
  
  showIndexDialog - VariantBool.TRUE, falls der Indexdialog beim Aufruf einer der angegebenen Methoden angezeigt werden soll
  
  Since:
  
  6.00.090
  
  See Also:
  
  IIntray.addDocumentFileToArchive(BStr, BStr, BStr), IIntray.addDocumentFileToArchivePath(BStr, BStr, BStr, BStr), IIntray.addDocumentFileToParent(Int32, BStr, BStr, BStr)
- addDocumentFileAsAttachment
  
  public VariantBool addDocumentFileAsAttachment(BStr documentFilePath, Int32 targetObjectId)
  
  Description copied from interface: IIntray
  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)
  Specified by:
  
  addDocumentFileAsAttachment in interface IIntray
  
  Parameters:
  
  documentFilePath - Dokumentenpfad mit der Datei für die neue Dateianbindung
  
  targetObjectId - Objekt Id eines Archivobjekts, welches ein Dokument ist
  
  Returns:
  
  VariantBool.TRUE falls kein Fehler aufgetreten ist
  
  Since:
  
  6.00.090
- setIndexFieldInIntray
  
  public VariantBool setIndexFieldInIntray(BStr documentFilePath, Int32 maskId, Int32 fieldId, BStr fieldValue)
  
  Description copied from interface: IIntray
  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")
  Specified by:
  
  setIndexFieldInIntray in interface IIntray
  
  Parameters:
  
  documentFilePath - 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
  
  Returns:
  
  VariantBool.TRUE, falls die Vorbedingung erfüllt ist und das Setzen des Indexfelds erfolgreich war bzw. kein Fehler aufgetreten ist
  
  Since:
  
  6.00.090
- setNameInIntray
  
  public VariantBool setNameInIntray(BStr documentFileName, BStr name)
  
  Description copied from interface: IIntray
  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")
  Specified by:
  
  setNameInIntray in interface IIntray
  
  Parameters:
  
  documentFileName - Name der Dokumentendatei ohne Dateipfad
  
  name - Beliebige Kurzbezeichnung
  
  Returns:
  
  VariantBool.TRUE, falls die Vorbedingung erfüllt ist und kein Fehler aufgetreten ist
  
  Since:
  
  6.00.090
- setDateInIntray
  
  public VariantBool setDateInIntray(BStr documentFileName, BStr date)
  
  Description copied from interface: IIntray
  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")
  Specified by:
  
  setDateInIntray in interface IIntray
  
  Parameters:
  
  documentFileName - Name der Dokumentendatei ohne Dateipfad
  
  date - Dokumentendatum yyyyMMddHHmmss
  
  Returns:
  
  VariantBool.TRUE, falls die Vorbedingung erfüllt ist und kein Fehler aufgetreten ist
  
  Since:
  
  6.00.090
- selectIntrayFiles
  
  public VariantBool selectIntrayFiles(BStr files)
  
  Description copied from interface: IIntray
  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")
  Specified by:
  
  selectIntrayFiles in interface IIntray
  
  Parameters:
  
  files - Dateinamen, getrennt durch ELO_SEPARATOR ¶
  
  Returns:
  
  VariantBool.TRUE falls die Vorbedingung erfüllt ist und kein Fehler aufgetreten ist
  
  Since:
  
  6.00.100
- getIntrayDirectoryPath
  
  public BStr getIntrayDirectoryPath()
  
  Description copied from interface: IIntray
  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
  Specified by:
  
  getIntrayDirectoryPath in interface IIntray
  
  Returns:
  
  Absoluter Dateipfad für das Postboxverzeichnis
  
  Since:
  
  6.00.100
- refreshIntray
  
  public VariantBool refreshIntray()
  
  Description copied from interface: IIntray
  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();
  Specified by:
  
  refreshIntray in interface IIntray
  
  Returns:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
  
  Since:
  
  6.00.100
- goBackward
  
  public void goBackward()
  
  Description copied from interface: INavigation
  Geht einen Schritt zurück. Das zuvor selektierte Objekt ist selektiert
  
  Vorbedingung: Ein Benutzer hat sich über die Login Methode angemeldet. Mindestens zwei verschiedene Archiv Objekte wurden nacheinander selektiert.
  
  Nachbedingung: Das zuvor selektierte Objekt ist selektiert
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.gotoObjectId 123 Elo.gotoObjectId 456 Elo.goBackward
  Specified by:
  
  goBackward in interface INavigation
- goForward
  
  public void goForward()
  
  Description copied from interface: INavigation
  Geht einen Schritt vor
  
  Vorbedingung: Ein Benutzer hat sich über die Login Methode angemeldet. Der Benutzer hat verschiedene Objekte selektiert und mindestens einmal die Funktion goBackward ausgeführt.
  
  Nachbedingung: Das zuvor selektierte Objekt ist selektiert
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login Elo.gotoObjectId 123 Elo.gotoObjectId 456 Elo.goBackward Elo.goForward
  Specified by:
  
  goForward in interface INavigation
- getReminderName
  
  public BStr getReminderName()
  
  Description copied from interface: IReminder
  Liefert den Namen des Wiedervorlagetermins
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Der Name des Wiedervorlagetermins wird zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... MsgBox Elo.getReminderName
  Specified by:
  
  getReminderName in interface IReminder
  
  Returns:
  
  Name der Wiedervorlage
- setReminderName
  
  public void setReminderName(BStr name)
  
  Description copied from interface: IReminder
  Setzt den Namen des Wiedervorlagetermins
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Der Name des Wiedervorlagetermins wird zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.setReminderName "foo"
  Specified by:
  
  setReminderName in interface IReminder
  
  Parameters:
  
  name - Name der Wiedervorlage
- getReminderCreateDate
  
  public BStr getReminderCreateDate()
  
  Description copied from interface: IReminder
  Liefert das Erstellungsdatum des selektierten Wiedervorlagetermins
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Das Erstellungsdatum des selektierten Wiedervorlagetermins wird zurückgeliefert
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... MsgBox Elo.getReminderCreateDate
  Specified by:
  
  getReminderCreateDate in interface IReminder
  
  Returns:
  
  Erstellungsdatum
- getReminderDescription
  
  public BStr getReminderDescription()
  
  Description copied from interface: IReminder
  Liefert den Beschreibungstext des selektierten Wiedervorlagetermins.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Der Beschreibungstext des selektierten Wiedervorlagetermins wird zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... MsgBox Elo.getReminderDescription
  Specified by:
  
  getReminderDescription in interface IReminder
  
  Returns:
  
  Beschreibung
- getReminderPromptDate
  
  public BStr getReminderPromptDate()
  
  Description copied from interface: IReminder
  Liefert den Termin für die Wiedervorlage
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Der Termin für die Wiedervorlage wird zurückgegeben
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... MsgBox Elo.getReminderPromptDate 'z. B. 20071205135400
  Specified by:
  
  getReminderPromptDate in interface IReminder
  
  Returns:
  
  Wiedervorlagentermin
- getReminderSenderId
  
  public Int32 getReminderSenderId()
  
  Description copied from interface: IReminder
  Liefert die Benutzer Id des Absenders/Erzeugers des selektierten Wiedervorlagetermins
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Die Benutzer Id des Absenders des Wiedervorlagetermins wird zurückgegeben
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... MsgBox Elo.getReminderSenderId
  Specified by:
  
  getReminderSenderId in interface IReminder
  
  Returns:
  
  Benutzer Id
- getReminderReceiverId
  
  public Int32 getReminderReceiverId()
  
  Description copied from interface: IReminder
  Liefert die Benutzer Id des Empfängers für einen selektierten Wiedervorlagetermin
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Die Benutzer Id des Empfängers für den ausgewählten Wiedervorlagetermin wird zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... MsgBox Elo.getReminderReceiverId
  Specified by:
  
  getReminderReceiverId in interface IReminder
  
  Returns:
  
  Benutzer Id
- getReminderPriority
  
  public Int32 getReminderPriority()
  
  Description copied from interface: IReminder
  Liefert die Priorität des selektierten Wiedervorlagetermins.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Die Priorität des selektierten Wiedervorlagetermins wird zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... MsgBox Elo.getReminderPriority
  Specified by:
  
  getReminderPriority in interface IReminder
  
  Returns:
  
  Priorität
- setReminderCreateDate
  
  public void setReminderCreateDate(BStr createDate)
  
  Description copied from interface: IReminder
  Setzt das Erstellungsdatum des selektierten Wiedervorlagetermins
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Das Erstellungsdatum des selektierten Wiedervorlagetermins wird gesetzt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.setReminderCreateDate 20071105
  Specified by:
  
  setReminderCreateDate in interface IReminder
  
  Parameters:
  
  createDate - Erstellungsdatum
- setReminderDescription
  
  public void setReminderDescription(BStr description)
  
  Description copied from interface: IReminder
  Setzt den Beschreibungstext des selektierten Wiedervorlagetermins
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Der Beschreibungstext des selektierten Wiedervorlagetermins wird zurückgegeben.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.setReminderDescription "Lorem ipsum dolor sit amet"
  Specified by:
  
  setReminderDescription in interface IReminder
  
  Parameters:
  
  description - Beschreibung
- setReminderPromptDate
  
  public void setReminderPromptDate(BStr date)
  
  Description copied from interface: IReminder
  Setzt den Termin für die Wiedervorlage
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Der Termin für die Wiedervorlage wird gesetzt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.setReminderPromptDate 20091010140000 'somewhere in the future
  Specified by:
  
  setReminderPromptDate in interface IReminder
  
  Parameters:
  
  date - Wiedervorlagentermin
- setReminderSenderId
  
  public void setReminderSenderId(Int32 fromUserId)
  
  Description copied from interface: IReminder
  Setzt die Benutzer Id des Absenders des selektierten Wiedervorlagetermins
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Die Benutzer Id des Absenders des selektierten Wiedervorlagetermins wird gesetzt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.setReminderSenderId 33
  Specified by:
  
  setReminderSenderId in interface IReminder
  
  Parameters:
  
  fromUserId - Benutzer Id
- setReminderReceiverId
  
  public void setReminderReceiverId(Int32 ownerUserId)
  
  Description copied from interface: IReminder
  Setzt die Benutzer Id des Empfängers für einen Wiedervorlagetermin
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Die Benutzer Id des Empfängers des Wiedervorlagetermins wird gesetzt
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.setReminderReceiverId 32
  Specified by:
  
  setReminderReceiverId in interface IReminder
  
  Parameters:
  
  ownerUserId - Benutzer Id
- setReminderPriority
  
  public void setReminderPriority(Int32 priority)
  
  Description copied from interface: IReminder
  Setzt die Priorität des selektierten Wiedervorlagetermins.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.
  
  Nachbedingung: Die Priorität des selektierten Wiedervorlagetermins wird gesetzt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.setReminderPriority 0
  Specified by:
  
  setReminderPriority in interface IReminder
  
  Parameters:
  
  priority - Priorität
- createNewReminder
  
  public Int32 createNewReminder(Int32 objectId, BStr receiverIds, BStr name, BStr message)
  
  Description copied from interface: IReminder
  Erstellt einen neuen Wiedervorlage Termin
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
  
  Nachbedingung: Ein neuer Wiedervorlage Termin wird angelegt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.createNewReminder 1198436, "11¶12¶13", "tester", "dies ist ein test"
  Specified by:
  
  createNewReminder in interface IReminder
  
  Parameters:
  
  objectId - Objekt ID des Strukturelements oder Dokuments
  
  receiverIds - Benutzer IDs der Empfänger des Wiedervorlage Termins, getrennt durch das Paragraph Symbol ¶
  
  name - Name des Wiedervorlage Termins
  
  message - Nachricht des Wiedervorlage Termins
  
  Returns:
  
  Die ID des neu erstellten Wiedervorlage Termins
- gotoReminder
  
  public VariantBool gotoReminder(Int32 reminderId)
  
  Description copied from interface: IReminder
  Wechselt in die Aufgabenansicht und selektiert den Wiedervorlagetermin mit der angegebenen Objekt Id.
  
  Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Ein Wiedervorlagetermin mit der angegebenen Wiedervorlage Objekt Id existiert im derzeit geöffneten Archiv und ist für den derzeit angemeldeten Benutzer aktiv/sichtbar.
  
  Nachbedingung: Der Wiedervorlage Termin in der Aufgaben Ansicht ist selektiert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.gotoReminder(23)
  Specified by:
  
  gotoReminder in interface IReminder
  
  Parameters:
  
  reminderId - Id des Wiedervorlage Objekts
  
  Returns:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- gotoWorkflow
  
  public VariantBool gotoWorkflow(Int32 workflowId, Int32 nodeId)
  
  Description copied from interface: IWorkflow
  
  Wechselt in die Aufgabenansicht und zeigt den angegebenen Workflow an. Die Angabe der nodeId ist optional und nur sinnvoll, wenn ein Anwender mehrere aktive Knoten des gleichen Workflows haben kann und diese unterschieden werden sollen. Wenn die nodeId 0 ist, wird der erste passende Workfloweintrag selektiert.
  
  Specified by:
  
  gotoWorkflow in interface IWorkflow
  
  Parameters:
  
  workflowId - Workflow Id
  
  nodeId - Knoten Id
  
  Returns:
  
  True, wenn der Workflow angesprungen werden konnte.
- getMaskIds
  
  public BStr getMaskIds()
  
  Description copied from interface: IMask
  Die Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert. Die Objekt Ids sind durch ClientConstants.ELO_SEPARATOR getrennt.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.
  
  Nachbedingung: Die Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... maskIds = Elo.getMaskIds
  Specified by:
  
  getMaskIds in interface IMask
  
  Returns:
  
  Die Objekt Ids aller Masken des aktiven Archivs
- getMaskNames
  
  public BStr getMaskNames()
  
  Description copied from interface: IMask
  Alle Maskennamen des aktiven Archivs werden zurückgeliefert. Die Maskennamen sind durch ClientConstants.ELO_SEPARATOR getrennt.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.
  
  Nachbedingung: Alle Maskennamen werden zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... maskNames = Elo.getMaskNames
  Specified by:
  
  getMaskNames in interface IMask
  
  Returns:
  
  Alle Maskennamen
- getMaskFields
  
  public BStr getMaskFields(Int32 maskId)
  
  Description copied from interface: IMask
  Liefert die Maskenfelder der Maske mit der angegebenen Masken Id.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.
  
  Nachbedingung: Die Maskenfelder der Maske mit der angegebenen Masken Id wurden zurückgeliefert.
  
  Fehlerbehandlung: Im Fehlerfall wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... maskFields = Elo.getMaskFields(20) 'Foo¶Bar¶Baz
  Specified by:
  
  getMaskFields in interface IMask
  
  Parameters:
  
  maskId - Id der Verschlagwortungsmaske
  
  Returns:
  
  Die Maskenfelder der Maske mit der angegebenen Masken Id, getrennt durch ELO_SEPARATOR
- getMaskNamesAndIds
  
  public BStr getMaskNamesAndIds()
  
  Description copied from interface: IMask
  Die Maskennamen und Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert. Dabei ist jeweils ein Maskenname einer Masken Id zugeordnet. Maskenname und Masken Id sind durch ^ getrennt. Die Paare aus Maskenname und Masken Id sind durch ClientConstants.ELO_SEPARATOR getrennt.
  
  Beispiel: Maske1^23¶Maske2^44¶Maske3^33 usw.
  
  Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.
  
  Nachbedingung: Die Maskennamen und Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... maskNamesAndIds = Elo.getMaskNamesAndIds
  Specified by:
  
  getMaskNamesAndIds in interface IMask
  
  Returns:
  
  Die Maskennamen und Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.
- commitObject
  
  public VariantBool commitObject()
  
  Description copied from interface: IObjectProperties
  Beendet die Bearbeitung des aktuellen Archivobjekts und speichert die Änderungen auf den Indexserver.
  
  Vorbedingung: Die Methode IObjectProperties.prepareObject(Int32) wurde aufgerufen und liefert VariantBool.TRUE.
  
  Nachbedingung: Die letzten Änderungen des aktuellen Archivobjekts wurden gespeichert. Zur Bearbeitung desselben oder eines anderen Archivobjekts muss erneut die Methode IObjectProperties.prepareObject(Int32) aufgerufen werden.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.set... Elo.set... Elo.set... Elo.set... Elo.commitObject
  Specified by:
  
  commitObject in interface IObjectProperties
  
  Returns:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- prepareObject
  
  public VariantBool prepareObject(Int32 objectId)
  
  Description copied from interface: IObjectProperties
  Wenn ein Archivobjekt (Dokument oder Ordner) bearbeitet werden soll, muss es zunächst mit IObjectProperties.prepareObject(Int32) identifiziert werden. Dann können die verschiedenen Set-Methoden aufgerufen werden. Zum endgültigen Speichern muss IObjectProperties.commitObject() aufgerufen werden.
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Ein Archivobjekt mit der angegebenen Objekt Id existiert im Archiv.
  
  Nachbedingung: Das Archivobjekt mit der angegebenen Objekt-Id kann jetzt bearbeitet werden.
  
  Fehlerbehandlung: Falls die ObjektId nicht existiert oder bei anderen Fehlern wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.set... Elo.set... Elo.set... Elo.set... Elo.commitObject
  Specified by:
  
  prepareObject in interface IObjectProperties
  
  Parameters:
  
  objectId - Objekt Id des Archivobjekts
  
  Returns:
  
  VariantBool.TRUE, falls die Objekt Id im Archiv vorhanden ist und kein Fehler aufgetreten ist
- setIndexField
  
  public VariantBool setIndexField(Int32 fieldId, BStr fieldValue)
  
  Description copied from interface: IObjectProperties
  Setzt das Indexfeld mit der angegebnen Id für das aktuelle Archivobjekt.
  
  Vorbedingung: Die Methode IObjectProperties.prepareObject(Int32) wurde aufgerufen und liefert VariantBool.TRUE.
  
  Nachbedingung: Das Indexfeld mit der angegebenen Id wurde auf den angebenen Wert gesetzt. Zum endgültigen Speichern muss IObjectProperties.commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.setIndexField 7,"Bar" Elo.commitObject
  Specified by:
  
  setIndexField in interface IObjectProperties
  
  Parameters:
  
  fieldId - Id des Indexfelds
  
  fieldValue - Neuer Wert des Indexfelds
  
  Returns:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- setMaskId
  
  public VariantBool setMaskId(Int32 maskId)
  
  Description copied from interface: ISearch
  Für die Suche wird die Maske mit der angegebenen Masken Id verwendet.
  
  Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Die Methode ISearch.prepareMaskSearch() wurde aufgerufen.
  
  Nachbedingung: Die Suche wird auf die Maske mit der angegebenen Masken Id beschränkt.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareMaskSearch() Elo.setMaskId(123) Elo.setMaskFieldValue("Von","Maus") Elo.setMaskFieldValue("An","Klaus") Elo.commitMaskSearch()
  Specified by:
  
  setMaskId in interface IObjectProperties
  
  Specified by:
  
  setMaskId in interface ISearch
  
  Parameters:
  
  maskId - Masken Id für die Suchmaske
  
  Returns:
  
  VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist
- setDescription
  
  public VariantBool setDescription(BStr description)
  
  Description copied from interface: IObjectProperties
  Setzt den Memo Text für das aktive Archivobjekt.
  
  Vorbedingung: Die Methode IObjectProperties.prepareObject(Int32) wurde aufgerufen und liefert VariantBool.TRUE.
  
  Nachbedingung: Der Memo Text für das Archivobjekt wurde gesetzt. Zum endgültigen Speichern muss IObjectProperties.commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.setDescription "Beschreibungstext" Elo.commitObject
  Specified by:
  
  setDescription in interface IObjectProperties
  
  Parameters:
  
  description - Memo Text
  
  Returns:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- setName
  
  public VariantBool setName(BStr name)
  
  Description copied from interface: IObjectProperties
  Setzt den Namen bzw. die Kurzbezeichnung des aktuellen Archivobjekts.
  
  Vorbedingung: Die Methode IObjectProperties.prepareObject(Int32) wurde aufgerufen und liefert VariantBool.TRUE.
  
  Nachbedingung: Der Name bzw. die Kurzbezeichnung des aktiven Archivobjekts wurde geändert. Zum endgültigen Speichern muss IObjectProperties.commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.setName "Foo" Elo.commitObject
  Specified by:
  
  setName in interface IObjectProperties
  
  Parameters:
  
  name - Name bzw. Kurzbezeichnung für das Archivobjekt
  
  Returns:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- getIndexField
  
  public BStr getIndexField(Int32 objectId, Int32 fieldId)
  
  Description copied from interface: IObjectProperties
  Liefert den Wert des Indexfelds mit der angegebenen fieldId für das Archivobjekt mit der angegebenen objectId:
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Ein Archivobjekt mit der angegebenen Objekt Id existiert im Archiv. Das Archivobjekt hat eine Dokumentenmaske, welche ein Feld mit der angegebenen fieldId enthält
  
  Nachbedingung: Der Wert des Indexfelds wird zurückgeliefert.
  
  Fehlerbehandlung: Falls einer der Punkte der Vorbedingung nicht erfüllt ist wird ein leerer String zurückgeliefert. Falls ein anderer Fehler auftritt wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... fieldValue = Elo.getIndexField(2,3)
  Specified by:
  
  getIndexField in interface IObjectProperties
  
  Parameters:
  
  objectId - Objekt Id eines existierenden Archivobjekts
  
  fieldId - Field Id eines Indexfelds in der Dokumentenmaske des Archivobjekts
  
  Returns:
  
  Wert des Indexfelds in der Dokumentenmaske des Archivobjekts
- getObjAclEx
  
  public BStr getObjAclEx(Int32 objectId)
  
  Description copied from interface: IObjectProperties
  Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen. Dabei ist für die Abfrage mindestens ein lesender Zugriff auf das Objekt notwendig, für das Setzen ein schreibender.
  
  Wenn Sie das Property abfragen erhalten Sie einen Text der Form <Eintrag>,<Eintrag>,...<Eintrag>
  Unter Eintrag steht erst mal ein Kennzeichen um was für ein Zugriffsrecht es sich handelt und anschließend die Nummer des betroffenen Schlüssels, Anwenders oder Gruppe. Das Kennzeichen ist immer mindestens einem Zeichen, folgende Möglichkeiten existieren:
  
  K Es handelt sich um einen Schlüsseleintrag
  R Ein Anwender- oder Gruppeneintrag mit Leserecht
  W Ein Anwender- oder Gruppeneintrag mit Schreibrecht
  D Ein Anwender- oder Gruppeneintrag mit Löschrecht
  E Ein Anwender- oder Gruppeneintrag mit Dateibearbeitungsrecht
  
  Die Kennzeichen R, W, D, E können miteinander kombiniert werden, K muss immer alleine mit einer Schlüsselnummer stehen.
  
  Beispiel: Sie erhalten einen Eintrag „K2,R3,RW4,RWDE5“. Dann ist der Schlüssel 2 gesetzt und der Anwender oder die Gruppe 3 hat Leserecht, 4 hat Lese- und Schreibrecht und 5 darf lesen, schreiben, das Dokument löschen und die Dokumentendatei bearbeiten..
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Das Archivobjekt mit der angegebenen Objekt Id existiert im Archiv.
  
  Nachbedingung: Die codierte Access Control List ACL wird zurückgeliefert.
  
  Fehlerbehandlung: Falls einer der Punkte der Vorbedingung nicht erfüllt ist wird ein leerer String zurückgeliefert. Falls ein anderer Fehler auftritt wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... acl = Elo.getObjAcl(487549)
  Specified by:
  
  getObjAclEx in interface IObjectProperties
  
  Parameters:
  
  objectId - Objekt Id eines Archivobjekts
  
  Returns:
  
  Codierte Access Control List ACL
- setObjAcl
  
  public void setObjAcl(BStr aclString)
  
  Description copied from interface: IObjectProperties
  Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen. Dabei ist für die Abfrage mindestens ein lesender Zugriff auf das Objekt notwendig, für das Setzen ein schreibender.
  
  Wenn Sie das Property abfragen erhalten Sie einen Text der Form <Eintrag>,<Eintrag>,...<Eintrag>
  Unter Eintrag steht erst mal ein Kennzeichen um was für ein Zugriffsrecht es sich handelt und anschließend die Nummer des betroffenen Schlüssels, Anwenders oder Gruppe. Das Kennzeichen ist immer mindestens einem Zeichen, folgende Möglichkeiten existieren:
  
  K Es handelt sich um einen Schlüsseleintrag
  R Ein Anwender- oder Gruppeneintrag mit Leserecht
  W Ein Anwender- oder Gruppeneintrag mit Schreibrecht
  D Ein Anwender- oder Gruppeneintrag mit Löschrecht
  E Ein Anwender- oder Gruppeneintrag mit Dateibearbeitungsrecht
  
  Die Kennzeichen R, W, D, E können miteinander kombiniert werden, K muss immer alleine mit einer Schlüsselnummer stehen.
  
  Beispiel: Sie erhalten einen Eintrag „K2,R3,RW4,RWDE5“. Dann ist der Schlüssel 2 gesetzt und der Anwender oder die Gruppe 3 hat Leserecht, 4 hat Lese- und Schreibrecht und 5 darf lesen, schreiben, das Dokument löschen und die Dokumentendatei bearbeiten..
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Die Methode IObjectProperties.prepareObject(Int32) wurde aufgerufen und liefert VariantBool.TRUE.
  
  Nachbedingung: Die Access Control List des aktiven Archivobjekts wurde geändert. Zum endgültigen Speichern muss IObjectProperties.commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Falls der angegebene ACL String nicht wohlgeformt ist, d.h. die Syntax von ACL Strings verletzt, wird VariantBool.FALSE zurückgeliefert. Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(487549) Elo.setObjAcl("K2,R3,RW4,RWDE5") Elo.commitObject()
  Specified by:
  
  setObjAcl in interface IObjectProperties
  
  Parameters:
  
  aclString - Wohlgeformter ACL String, siehe oben
- setObjAcl2
  
  public VariantBool setObjAcl2(BStr aclString)
  
  Description copied from interface: IObjectProperties
  Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen. Dabei ist für die Abfrage mindestens ein lesender Zugriff auf das Objekt notwendig, für das Setzen ein schreibender.
  
  Wenn Sie das Property abfragen erhalten Sie einen Text der Form <Eintrag>,<Eintrag>,...<Eintrag>
  Unter Eintrag steht erst mal ein Kennzeichen um was für ein Zugriffsrecht es sich handelt und anschließend die Nummer des betroffenen Schlüssels, Anwenders oder Gruppe. Das Kennzeichen ist immer mindestens einem Zeichen, folgende Möglichkeiten existieren:
  
  K Es handelt sich um einen Schlüsseleintrag
  R Ein Anwender- oder Gruppeneintrag mit Leserecht
  W Ein Anwender- oder Gruppeneintrag mit Schreibrecht
  D Ein Anwender- oder Gruppeneintrag mit Löschrecht
  E Ein Anwender- oder Gruppeneintrag mit Dateibearbeitungsrecht
  
  Die Kennzeichen R, W, D, E können miteinander kombiniert werden, K muss immer alleine mit einer Schlüsselnummer stehen.
  
  Beispiel: Sie erhalten einen Eintrag „K2,R3,RW4,RWDE5“. Dann ist der Schlüssel 2 gesetzt und der Anwender oder die Gruppe 3 hat Leserecht, 4 hat Lese- und Schreibrecht und 5 darf lesen, schreiben, das Dokument löschen und die Dokumentendatei bearbeiten..
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Die Methode IObjectProperties.prepareObject(Int32) wurde aufgerufen und liefert VariantBool.TRUE.
  
  Nachbedingung: Die Access Control List des aktiven Archivobjekts wurde geändert. Zum endgültigen Speichern muss IObjectProperties.commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Falls der angegebene ACL String nicht wohlgeformt ist, d.h. die Syntax von ACL Strings verletzt, wird VariantBool.FALSE zurückgeliefert. Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(487549) success = Elo.setObjAcl2("K2,R3,RW4,RWDE5") Elo.commitObject()
  Specified by:
  
  setObjAcl2 in interface IObjectProperties
  
  Parameters:
  
  aclString - Wohlgeformter ACL String, siehe oben
  
  Returns:
  
  VariantBool.TRUE bei Erfolg
- startInstall
  
  public void startInstall(BStr importUrl)
  
  Description copied from interface: IWorkspace
  
  Startet den Download und Import des Installationspakets aus der URL.
  
  Specified by:
  
  startInstall in interface IWorkspace
  
  Parameters:
  
  importUrl - URL
- isLoginVisible
  
  public VariantBool isLoginVisible()
  
  Description copied from interface: IWorkspace
  
  Abfrage ob der Login-Dialog sichtbar ist.
  Specified by:
  
  isLoginVisible in interface IWorkspace
  
  Returns:
  
  VariantBool.TRUE falls der Login-Dialog sichtbar ist.
  VariantBool.FALSE falls der Login-Dialog nicht sichtbar ist.
- getLastScriptResult
  
  public BStr getLastScriptResult()
  
  Description copied from interface: IWorkspace
  
  Liefert den Rückgabewert des letzten IWorkspace.runScriptFunction(BStr, BStr) oder IWorkspace.runScriptFunctionEx(BStr, BStr) aufrufs.
  
  Specified by:
  
  getLastScriptResult in interface IWorkspace
  
  Returns:
  
  Java Script Rückgabewert
- awaitLogin
  
  public void awaitLogin()
  
  Description copied from interface: IWorkspace
  
  Blockiert den weiteren COM Ablauf bis ein erfolgreicher Login durchgeführt wurde.
  
  Specified by:
  
  awaitLogin in interface IWorkspace

Class EloComServer

Field Summary

Fields inherited from class IDispatchServer

Fields inherited from class IUnknownServer

Fields inherited from interface IArchivedObject

Fields inherited from interface IDispatch

Fields inherited from interface IDocument

Fields inherited from interface IIntray

Fields inherited from interface IMask

Fields inherited from interface INavigation

Fields inherited from interface IObjectProperties

Fields inherited from interface IPersist

Fields inherited from interface IPreview

Fields inherited from interface IReminder

Fields inherited from interface ISearch

Fields inherited from interface IUnknown

Fields inherited from interface IUser

Fields inherited from interface IWorkflow

Fields inherited from interface IWorkspace

Constructor Summary

Method Summary

Methods inherited from class DispatchComServer

Methods inherited from class IDispatchServer

Methods inherited from class IUnknownServer

Methods inherited from class Object

Methods inherited from interface AutoDeleteParameter

Methods inherited from interface IDispatch

Methods inherited from interface IUnknown

Field Details

Constructor Details

Method Details