de.elo.client.comserver
Class EloComServer

java.lang.Object
  com.jniwrapper.win32.com.server.IUnknownServer
      com.jniwrapper.win32.com.server.IDispatchServer
          com.jniwrapper.win32.com.DispatchComServer
              de.elo.client.comserver.EloComServer

All Implemented Interfaces:

com.jniwrapper.AutoDeleteParameter, com.jniwrapper.win32.automation.IDispatch, com.jniwrapper.win32.com.IPersist, com.jniwrapper.win32.com.IUnknown, de.elo.client.comserver.IAppointment, de.elo.client.comserver.IArchivedObject, de.elo.client.comserver.IDocument, de.elo.client.comserver.IIntray, de.elo.client.comserver.IMask, de.elo.client.comserver.INavigation, de.elo.client.comserver.IObjectProperties, de.elo.client.comserver.IPreview, de.elo.client.comserver.IReminder, de.elo.client.comserver.ISearch, de.elo.client.comserver.IUser, de.elo.client.comserver.IWorkspace

public class EloComServer
extends com.jniwrapper.win32.com.DispatchComServer
implements com.jniwrapper.win32.com.IPersist, de.elo.client.comserver.IWorkspace, de.elo.client.comserver.IPreview, de.elo.client.comserver.IDocument, de.elo.client.comserver.ISearch, de.elo.client.comserver.IArchivedObject, de.elo.client.comserver.IUser, de.elo.client.comserver.IIntray, de.elo.client.comserver.INavigation, de.elo.client.comserver.IReminder, de.elo.client.comserver.IMask, de.elo.client.comserver.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/).

Die Dokumentation des Entwurfs liegt im Produktionsarchiv lldo_prod unter dem Pfad lldo_prod / 7. Entwicklung / Dokumente / Programm- und Schnittstellendokumentation / ELOprofessional/ELOenterprise 6.0 / Java Client / Entwurf / Java Com Server

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

Field Summary

static com.jniwrapper.win32.com.types.CLSID	COM_SERVER_CLSID
static java.lang.String	COM_SERVER_DESCRIPTION
static java.lang.String	PROG_ID
static java.lang.String	VERSION_INDEPENDENT_PROG_ID

Fields inherited from class com.jniwrapper.win32.com.server.IDispatchServer

a, e, i, q, r, s, u, x

Fields inherited from interface com.jniwrapper.win32.com.IPersist

INTERFACE_IDENTIFIER

Fields inherited from interface de.elo.client.comserver.IWorkspace

ARCHIVE_NOT_FOUND, COULD_NOT_CONNECT, EXCEPTION, OK

Fields inherited from interface de.elo.client.comserver.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, UNKNOWN_ORIGIN

Constructor Summary

EloComServer(com.jniwrapper.win32.com.server.CoClassMetaInfo classImpl)

Method Summary

void	activateAttachmentOfSelectedDocument() Öffnet die Dateianbindung eines in der Baumansicht selektierten Dokuments mit einem externen Programm.
com.jniwrapper.win32.automation.types.VariantBool	addAttachmentToSelectedDocument(com.jniwrapper.win32.automation.types.BStr attachmentFilePath) Fügt dem in der Baumansicht ausgewählten Dokument eine Dateianbindung (Attachment) hinzu.
com.jniwrapper.win32.automation.types.VariantBool	addDocumentFileAsAttachment(com.jniwrapper.win32.automation.types.BStr documentFilePath, com.jniwrapper.Int32 targetObjectId) Seiteneffekte: Fügt die Dokumenten Datei mit dem angegebenen Dateipfad dem Archivdokument hinzu, welches die angegebene Objekt Id besitzt.
com.jniwrapper.Int32	addDocumentFileToArchive(com.jniwrapper.win32.automation.types.BStr absoluteFilePath, com.jniwrapper.win32.automation.types.BStr documentName, com.jniwrapper.win32.automation.types.BStr documentDate) Fügt ein lokales Dokument in das Archiv ein.
com.jniwrapper.Int32	addDocumentFileToArchivePath(com.jniwrapper.win32.automation.types.BStr documentFilePath, com.jniwrapper.win32.automation.types.BStr documentName, com.jniwrapper.win32.automation.types.BStr documentDate, com.jniwrapper.win32.automation.types.BStr archivePath) Fügt ein lokales Dokument in das Archiv ein.
com.jniwrapper.win32.automation.types.BStr	addDocumentFileToIntray(com.jniwrapper.win32.automation.types.BStr absoluteFilePath) Kopiert eine Datei aus dem lokalen Filesystem in die Postbox.
com.jniwrapper.Int32	addDocumentFileToParent(com.jniwrapper.Int32 parentObjectId, com.jniwrapper.win32.automation.types.BStr absoluteFilePath, com.jniwrapper.win32.automation.types.BStr documentName, com.jniwrapper.win32.automation.types.BStr documentDate) Fügt ein lokales Dokument unterhalb eines Parent Objekts in das Archiv ein.
com.jniwrapper.Int32	ARCHIVE_NOT_FOUND() Konstante: Das Archiv wurde nicht gefunden
com.jniwrapper.win32.automation.types.VariantBool	archivePathExists(com.jniwrapper.win32.automation.types.BStr archivePath) VariantBool.TRUE, falls der angegebene Archivpfad im aktuell geöffneten Archiv vorhanden ist.
com.jniwrapper.Int32	checkInDocument(com.jniwrapper.win32.automation.types.BStr absoluteFilePath, com.jniwrapper.win32.automation.types.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.
com.jniwrapper.win32.automation.types.BStr	checkOutDocument(com.jniwrapper.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.
com.jniwrapper.Int32	chooseTargetObject(com.jniwrapper.Int32 mode, com.jniwrapper.win32.automation.types.BStr dialogTitle) Der TreeSelectDialog wird angezeigt.
void	clear() Löscht die aktuelle Dokumentenvorschau und zeigt die Meldung "Kein Dokument zur Ansicht ausgewählt." an.
com.jniwrapper.Int32	commitMaskSearch() Startet die Maskensuche.
com.jniwrapper.win32.automation.types.VariantBool	commitObject() Beendet die Bearbeitung des aktuellen Archivobjekts und speichert die Änderungen auf den Indexserver.
com.jniwrapper.Int32	COULD_NOT_CONNECT() Konstante: Verbindungsfehler
com.jniwrapper.Int32	createNewReminder(com.jniwrapper.Int32 objectId, com.jniwrapper.win32.automation.types.BStr receiverIds, com.jniwrapper.win32.automation.types.BStr name, com.jniwrapper.win32.automation.types.BStr message) Erstellt einen neuen Wiedervorlage Termin Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.win32.automation.types.VariantBool	createReference(com.jniwrapper.Int32 objectId, com.jniwrapper.Int32 newParentId) Erzeugt eine Referenz für ein Archivobjekt in einem Archivordner.
com.jniwrapper.win32.automation.types.VariantBool	createSubFolder(com.jniwrapper.win32.automation.types.BStr archivePath, com.jniwrapper.win32.automation.types.BStr folderName) Erstellt einen neuen Unterordner unterhalb des angegebenen Archivpfades.
com.jniwrapper.win32.automation.types.BStr	createTempCopy(com.jniwrapper.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	displayLocalFile(com.jniwrapper.win32.automation.types.BStr fileName) Stellt die Dokumentenvorschau auf eine lokale Datei, z.B. aus der Postbox ein.
com.jniwrapper.Int32	EXCEPTION() Konstante: Eine Exception ist aufgetreten
com.jniwrapper.Int32	getActiveView() Liefert den Code für die momentan aktive Ansicht Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
com.jniwrapper.win32.automation.types.BStr	getArchiveLocation() Liefert den Archivpfad des aktiven Archivs.
com.jniwrapper.win32.automation.types.BStr	getArchiveName() Liefert den Archivnamen des aktiven Archivs.
com.jniwrapper.win32.automation.types.BStr	getAttachmentFilePaths(com.jniwrapper.Int32 objectId) Liefert die lokal gecacheten Attachment Dateien für ein Dokument im Archiv Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
void	getClassID(com.jniwrapper.win32.com.types.CLSID pClassID) This method retrieves the class identifier (CLSID) of an object.
com.jniwrapper.win32.automation.types.BStr	getComServerDescription()
com.jniwrapper.win32.automation.types.BStr	getDelimiter() Das Trennzeichen für Arrays, die in Strings kodiert werden.
com.jniwrapper.Int32	getFileOrigin(com.jniwrapper.win32.automation.types.BStr absoluteFilePath) Liefert den Code für das Herkunftsverzeichnis einer Datei begzüglich auf das momentan geöffnete Archiv.
com.jniwrapper.win32.automation.types.BStr	getGroupNames() Liefert alle vorhandenen Gruppennamen in einem String.
com.jniwrapper.Int32	getIdFromArchivePath(com.jniwrapper.win32.automation.types.BStr archivePath) Liefert die Objekt Id eines Archivobjekts, welches über den angegebenen Archivpfad identifiziert wird.
com.jniwrapper.win32.automation.types.BStr	getIndexField(com.jniwrapper.Int32 objectId, com.jniwrapper.Int32 fieldId) 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.
com.jniwrapper.win32.automation.types.BStr	getIntrayDirectoryPath() Liefert den absoluten Dateipfad für das Postboxverzeichnis Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.win32.automation.types.BStr	getLinks(com.jniwrapper.Int32 objectId) Liefert die Objekt Ids der verlinkten Archivobjekte Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
com.jniwrapper.win32.automation.types.BStr	getMaskFields(com.jniwrapper.Int32 maskId) Liefert die Maskenfelder der Maske mit der angegebenen Masken Id.
com.jniwrapper.win32.automation.types.BStr	getMaskIds() Die Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.
com.jniwrapper.win32.automation.types.BStr	getMaskNames() Alle Maskennamen des aktiven Archivs werden zurückgeliefert.
com.jniwrapper.win32.automation.types.BStr	getMaskNamesAndIds() Die Maskennamen und Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.
com.jniwrapper.win32.automation.types.BStr	getMD5Hash(com.jniwrapper.win32.automation.types.BStr filePath) Liefert den MD5 Hash für eine lokale Datei Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
com.jniwrapper.Int32	getNumberOfIntrayFiles() Liefert die Anzahl der Dateien in der Postbox.
com.jniwrapper.win32.automation.types.BStr	getObjAcl(com.jniwrapper.Int32 objectId) Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen.
com.jniwrapper.Int32	getObjectMaskId(com.jniwrapper.Int32 objectId) Liefert die Masken Id des Archivobjekts mit der angegebenen Objekt Id Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet.
com.jniwrapper.win32.automation.types.BStr	getObjectTreePath(com.jniwrapper.Int32 objectId) Liefert den Pfad des Archivobjekts im Archivbaum.
com.jniwrapper.win32.automation.types.BStr	getProgId()
com.jniwrapper.win32.automation.types.BStr	getReminderCreateDate() Liefert das Erstellungsdatum des selektierten Wiedervorlagetermins Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.win32.automation.types.BStr	getReminderDescription() Liefert den Beschreibungstext des selektierten Wiedervorlagetermins.
com.jniwrapper.win32.automation.types.BStr	getReminderName() Liefert den Namen des Wiedervorlagetermins Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.Int32	getReminderPriority() Liefert die Priorität des selektierten Wiedervorlagetermins.
com.jniwrapper.win32.automation.types.BStr	getReminderPromptDate() Liefert den Termin für die Wiedervorlage Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.Int32	getReminderReceiverId() Liefert die Benutzer Id des Empfängers für einen selektierten Wiedervorlagetermin Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.Int32	getReminderSenderId() Liefert die Benutzer Id des Absenders/Erzeugers des selektierten Wiedervorlagetermins Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.Int32	getSelectedDocumentId() Liefert die Objekt-Id eines in der Baumansicht selektierten Dokuments.
com.jniwrapper.win32.automation.types.BStr	getSelectedDocumentName() Liefert den Namen eines in der Baumansicht selektierten Dokuments.
com.jniwrapper.win32.automation.types.BStr	getSelectedIntrayFile() Liefert den Dateipfad der in der Postbox zuoberst selektierten Datei.
com.jniwrapper.Int32	getSelectedObjectChildCount() Liefert die Anzahl der Kindknoten eines im Archiv/Klemmbrett selektierten Objekts.
com.jniwrapper.win32.automation.types.BStr	getSelectedObjectExternalIsoDate() Liefert das externe Datum (Dokumentendatum) für ein selektiertes ArchivObjekt.
com.jniwrapper.win32.automation.types.BStr	getSelectedObjectGUID() Liefert die GUID eines im Archiv/Klemmbrett selektierten Objekts.
com.jniwrapper.Int32	getSelectedObjectId() Liefert die Objekt Id eines im Archiv/Klemmbrett selektierten Objekts.
com.jniwrapper.win32.automation.types.BStr	getSelectedObjectInternalIsoDate() Liefert das interne Datum (Ablagedatum) für ein selektiertes ArchivObjekt.
com.jniwrapper.win32.automation.types.BStr	getSelectedObjectName() Liefert die Kurzbezeichnung eines im Archiv/Klemmbrett selektierten Objekts.
com.jniwrapper.Int32	getSelectedObjectParentId() Liefert die Parent Id eines im Archiv/Klemmbrett selektierten Objekts.
com.jniwrapper.Int32	getSelectedObjectType() Liefert den Typ eines im Archiv/Klemmbrett selektierten Objekts.
com.jniwrapper.win32.automation.types.BStr	getSubFolders(com.jniwrapper.win32.automation.types.BStr archivePath) Liefert die Namen der Unterverzeichnisse zu dem angegebenen Archivpfad.
com.jniwrapper.win32.automation.types.BStr	getUserName(com.jniwrapper.Int32 userId) Liefert den Benutzernamen zu einer existierenden Benutzer Id.
com.jniwrapper.win32.automation.types.BStr	getUserNames() Liefert alle vorhandenen Benutzernamen in einem String.
com.jniwrapper.win32.automation.types.BStr	getVersion() Liefert die aktuelle Versionsnummer des Java Clients.
com.jniwrapper.win32.automation.types.BStr	getVersionIndependentProgId()
void	goBackward() Geht einen Schritt zurück.
void	goForward() Geht einen Schritt vor Vorbedingung: Ein Benutzer hat sich über die Login Methode angemeldet.
com.jniwrapper.win32.automation.types.VariantBool	gotoObjectId(com.jniwrapper.Int32 id) Das SORD Objekt mit der angegebnen Objekt ID wird im TreeView in der Archivansicht ausgewählt/selektiert.
com.jniwrapper.win32.automation.types.VariantBool	gotoReminder(com.jniwrapper.Int32 reminderId) Wechselt in die Aufgabenansicht und selektiert den Wiedervorlagetermin mit der angegebenen Objekt Id.
com.jniwrapper.win32.automation.types.VariantBool	hasNext() Liefert VariantBool.TRUE falls das letzte Element des Iterators noch nicht erreicht wurde.
void	login(com.jniwrapper.win32.automation.types.BStr archiveName, com.jniwrapper.win32.automation.types.BStr archivePath, com.jniwrapper.win32.automation.types.BStr userName, com.jniwrapper.win32.automation.types.BStr userPassword) Die Login-Methode authentifiziert einen Benutzer für den Zugriff auf ein Archiv.
com.jniwrapper.win32.automation.types.VariantBool	loginWithDialog() Startet den Login Dialog.
com.jniwrapper.win32.automation.types.VariantBool	makeLink(com.jniwrapper.Int32 sourceObjectId, com.jniwrapper.Int32 destinationObjectId) Seiteneffekte: Verlinkt das Quellobjekt (Source) mit dem Zielobjekt (Destination).
void	minimize() Minimiert das Fenster des Java Client Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
com.jniwrapper.win32.automation.types.BStr	nextGuid() 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("jniwrapper.elocomserver") Elo.login Elo.search "foobar" while (Elo.hasNext()) MsgBox Elo.nextGuid() wend
com.jniwrapper.win32.automation.types.BStr	nextName() 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("jniwrapper.elocomserver") Elo.login Elo.search "foobar" while (Elo.hasNext()) MsgBox Elo.nextName() wend
com.jniwrapper.Int32	nextObjectId() 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("jniwrapper.elocomserver") Elo.login Elo.search "foobar" while (Elo.hasNext()) MsgBox Elo.nextObjectId() wend
com.jniwrapper.Int32	OK() Konstante: Alles OK
void	openSelectedDocument() Das in der Baumansicht ausgewählte Dokument wird geöffnet und von einem externen Programm angezeigt.
com.jniwrapper.win32.automation.types.VariantBool	prepareMaskSearch() Die Funktion wird aufgerufen wenn eine neue Maskensuche durchgeführt werden soll.
com.jniwrapper.win32.automation.types.VariantBool	prepareObject(com.jniwrapper.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.
com.jniwrapper.win32.automation.types.VariantBool	refreshIntray() Lädt die Dateien in der Posbox neu.
void	removeAttachmentOfSelectedDocument() Entfernt die Dateianbindung des in der Baumansicht selektierten Dokuments.
com.jniwrapper.Int32	runScriptFunction(com.jniwrapper.win32.automation.types.BStr functionName, com.jniwrapper.win32.automation.types.BStr parameters) Startet die JavaScript Funktion mit dem angegebenen Namen.
void	scanMultiPage() Scannt eine Menge von Seiten.
void	scanSinglePage() Scannt eine Menge von Seiten.
com.jniwrapper.Int32	search(com.jniwrapper.win32.automation.types.BStr searchString) Es wird nach einem Objekt mit dem angegebenen Namen (Kurzbezeichnung) gesucht.
com.jniwrapper.Int32	searchByDate(com.jniwrapper.win32.automation.types.BStr isoDate) Sucht nach Dokumenten, die zu dem angegebenen Datum passen oder in dem angegebenen Zeitraum liegen.
com.jniwrapper.Int32	searchByIndex(com.jniwrapper.win32.automation.types.BStr fieldGroupName, com.jniwrapper.win32.automation.types.BStr searchString) Maskenübergreifende Suche in einem Indexfeld Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
com.jniwrapper.Int32	searchByMD5Hash(com.jniwrapper.win32.automation.types.BStr md5Hash) Suche nach MD5 Hash.
com.jniwrapper.Int32	searchByNotes(com.jniwrapper.win32.automation.types.BStr searchString) Sucht nach Dokumenten, die eine Haftnotiz mit dem angegebenen Text enthalten.
com.jniwrapper.Int32	searchFulltext(com.jniwrapper.win32.automation.types.BStr searchString) Eine Volltextsuche nach einem Objekt mit dem angegebenen Namen wird durchgeführt.
com.jniwrapper.Int32	searchIds(com.jniwrapper.win32.automation.types.BStr objectIds, com.jniwrapper.win32.automation.types.BStr searchViewTitle) Die Archivobjekte mit den angegebenen Objekt Ids werden in der Suchansicht angezeigt.
void	selectAllIntrayRows() Selektiert alle Zeilen/Dateien in der Postbox Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.win32.automation.types.VariantBool	selectIntrayFiles(com.jniwrapper.win32.automation.types.BStr files) Seiteneffekte: Die angegebenen Dateien werden in der Postbox selektiert.
void	selectIntrayRow(com.jniwrapper.Int32 index) Selektiert in der Postbox die Zeile mit dem angegebenen Index Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.win32.automation.types.VariantBool	sendSelectedDocument(com.jniwrapper.win32.automation.types.BStr receiverMailAddress) Das in der Baumansicht ausgewählte Dokument wird wird an die angegebene E-Mail Adresse gesendet.
com.jniwrapper.win32.automation.types.VariantBool	setDateInIntray(com.jniwrapper.win32.automation.types.BStr documentFileName, com.jniwrapper.win32.automation.types.BStr date) Seiteneffekte: Setzt das Dokumentendatum der angegebenen Datei in der Postbox Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.win32.automation.types.VariantBool	setDescription(com.jniwrapper.win32.automation.types.BStr description) Setzt den Memo Text für das aktive Archivobjekt.
com.jniwrapper.win32.automation.types.VariantBool	setIndexField(com.jniwrapper.Int32 fieldId, com.jniwrapper.win32.automation.types.BStr fieldValue) Setzt das Indexfeld mit der angegebnen Id für das aktuelle Archivobjekt.
com.jniwrapper.win32.automation.types.VariantBool	setIndexFieldInIntray(com.jniwrapper.win32.automation.types.BStr documentFilePath, com.jniwrapper.Int32 maskId, com.jniwrapper.Int32 fieldId, com.jniwrapper.win32.automation.types.BStr fieldValue) Seiteneffekte: Setzt ein Indexfeld eines Dokuments in der Postbox.
com.jniwrapper.win32.automation.types.VariantBool	setMaskFieldValue(com.jniwrapper.win32.automation.types.BStr maskFieldName, com.jniwrapper.win32.automation.types.BStr maskFieldValue) Setzt ein Maskenfeld der Suchmaske auf einen bestimmten Wert.
com.jniwrapper.win32.automation.types.VariantBool	setMaskId(com.jniwrapper.Int32 maskId) Für die Suche wird die Maske mit der angegebenen Masken Id verwendet.
com.jniwrapper.win32.automation.types.VariantBool	setMaskName(com.jniwrapper.win32.automation.types.BStr maskName) Für die Suche wird die Maske mit dem angegebenen Maskennamen verwendet.
com.jniwrapper.win32.automation.types.VariantBool	setName(com.jniwrapper.win32.automation.types.BStr name) Setzt den Namen bzw. die Kurzbezeichnung des aktuellen Archivobjekts.
com.jniwrapper.win32.automation.types.VariantBool	setNameInIntray(com.jniwrapper.win32.automation.types.BStr documentFileName, com.jniwrapper.win32.automation.types.BStr name) Seiteneffekte: Setzt die Kurzbezeichnung der angegebenen Datei in der Postbox Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
com.jniwrapper.win32.automation.types.VariantBool	setObjAcl(com.jniwrapper.win32.automation.types.BStr aclString) Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen.
void	setReminderCreateDate(com.jniwrapper.win32.automation.types.BStr createDate) Setzt das Erstellungsdatum des selektierten Wiedervorlagetermins Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
void	setReminderDescription(com.jniwrapper.win32.automation.types.BStr description) Setzt den Beschreibungstext des selektierten Wiedervorlagetermins Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
void	setReminderName(com.jniwrapper.win32.automation.types.BStr name) Setzt den Namen des Wiedervorlagetermins Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
void	setReminderPriority(com.jniwrapper.Int32 priority) Setzt die Priorität des selektierten Wiedervorlagetermins.
void	setReminderPromptDate(com.jniwrapper.win32.automation.types.BStr date) Setzt den Termin für die Wiedervorlage Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
void	setReminderReceiverId(com.jniwrapper.Int32 ownerUserId) Setzt die Benutzer Id des Empfängers für einen Wiedervorlagetermin Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
void	setReminderSenderId(com.jniwrapper.Int32 fromUserId) Setzt die Benutzer Id des Absenders des selektierten Wiedervorlagetermins Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
void	setShowIndexDialog(com.jniwrapper.win32.automation.types.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(com.jniwrapper.Int32 id) Stellt die Dokumentenvorschau auf eine neue ObjektId ein.
void	showIntrayView() Im Workspace wird auf die Postbox Ansicht umgeschaltet.
com.jniwrapper.win32.automation.types.VariantBool	showSearchDialog() Seiteneffekte: Der Suchdialog wird angezeigt Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
void	showSearchView() Im Workspace wird auf die oberste Suchansicht umgeschaltet.
void	sortSearchList(com.jniwrapper.Int32 column, com.jniwrapper.Int32 mode) Sortiert die Liste/Tabelle mit den Suchergebnissen Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(BStr, BStr, BStr, BStr)- Methode am System angemeldet.
void	startFunction(com.jniwrapper.win32.automation.types.BStr functionName) Die Funktion mit dem angegebenen Funktionsbezeichnung wird ausgeführt Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
void	startFunction(com.jniwrapper.Int32 functionID) Die Funktion mit der angegebenen Funktions ID wird ausgeführt Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
com.jniwrapper.Int32	switchToArchive(com.jniwrapper.win32.automation.types.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 Vorbedingung: Ein Benutzer hat sich angemeldet bzw. eine Workspace Ansicht ist aktiv.
void	unselectAllIntrayRows() Die Auswahl von Zeilen/Dateien in der Postbox wird aufgehoben Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.
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.
com.jniwrapper.win32.automation.types.VariantBool	userIdExists(com.jniwrapper.Int32 userId) Liefert True, falls ein Benutzer mit der angegebenen Benutzer Id existiert.
com.jniwrapper.win32.automation.types.VariantBool	userNameExists(com.jniwrapper.win32.automation.types.BStr userName) Liefert True, falls ein Benutzer mit dem angegebenen Benutzernamen existiert.

Methods inherited from class com.jniwrapper.win32.com.DispatchComServer

release

Methods inherited from class com.jniwrapper.win32.com.server.IDispatchServer

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

Methods inherited from class com.jniwrapper.win32.com.server.IUnknownServer

addRef, addRefAggregated, b, create, destroy, doQueryInterface, getRefCount, isAutoDelete, isNull, queryInterface, queryInterfaceAggregated, releaseAggregated, setAutoDelete, setNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jniwrapper.win32.automation.IDispatch

getIDsOfNames, getTypeInfo, getTypeInfoCount, invoke

Methods inherited from interface com.jniwrapper.win32.com.IUnknown

addRef, isNull, queryInterface, release, setNull

Methods inherited from interface com.jniwrapper.AutoDeleteParameter

isAutoDelete, setAutoDelete

Field Detail

COM_SERVER_CLSID

public static final com.jniwrapper.win32.com.types.CLSID COM_SERVER_CLSID

PROG_ID

public static final java.lang.String PROG_ID

See Also:

Constant Field Values

VERSION_INDEPENDENT_PROG_ID

public static final java.lang.String VERSION_INDEPENDENT_PROG_ID

See Also:

Constant Field Values

COM_SERVER_DESCRIPTION

public static final java.lang.String COM_SERVER_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

EloComServer

public EloComServer(com.jniwrapper.win32.com.server.CoClassMetaInfo classImpl)

Method Detail

getClassID

public void getClassID(com.jniwrapper.win32.com.types.CLSID pClassID)
                throws com.jniwrapper.win32.com.ComException

This method retrieves the class identifier (CLSID) of an object.

Specified by:

getClassID in interface com.jniwrapper.win32.com.IPersist

Parameters:

pClassID - the class identifier (CLSID) of an object

Throws:

com.jniwrapper.win32.com.ComException

getProgId

public com.jniwrapper.win32.automation.types.BStr getProgId()

getVersionIndependentProgId

public com.jniwrapper.win32.automation.types.BStr getVersionIndependentProgId()

getComServerDescription

public com.jniwrapper.win32.automation.types.BStr getComServerDescription()

login

public void login(com.jniwrapper.win32.automation.types.BStr archiveName,
                  com.jniwrapper.win32.automation.types.BStr archivePath,
                  com.jniwrapper.win32.automation.types.BStr userName,
                  com.jniwrapper.win32.automation.types.BStr userPassword)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login "Mein Archiv" "http://testserver:8080/ix-elo/ix" "Benutzername" "Passwort"
 

Specified by:

login in interface de.elo.client.comserver.IWorkspace

Parameters:

archiveName - (beliebiger) Name des Archivs

archivePath - Pfad zum Archiv auf dem Indexserver

userName - Benutzername

userPassword - Benutzerpasswort

loginWithDialog

public com.jniwrapper.win32.automation.types.VariantBool loginWithDialog()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 

Specified by:

loginWithDialog in interface de.elo.client.comserver.IWorkspace

Returns:

• VariantBool.TRUE falls die Anmeldung erfolgreich war.
• VariantBool.FALSE falls auf Abbrechen geklickt wurde oder im Fehlerfall

gotoObjectId

public com.jniwrapper.win32.automation.types.VariantBool gotoObjectId(com.jniwrapper.Int32 id)

Description copied from interface: de.elo.client.comserver.IWorkspace

Das SORD Objekt 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: Das Objekt mit der angegebenen ID wird angezeigt.

Beispiel mit Visual Basic:

 set Elo = CreateObject("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436
 

Specified by:

gotoObjectId in interface de.elo.client.comserver.IWorkspace

Parameters:

id - Objekt ID des Archivobjekts

Returns:

TRUE, falls ein Archivobjekt mit der angegebene Id existiert und kein Fehler aufgetreten ist

showAppointmentView

public void showAppointmentView()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.showAppointmentView
 

Specified by:

showAppointmentView in interface de.elo.client.comserver.IWorkspace

showArchiveView

public void showArchiveView()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.showArchiveView
 

Specified by:

showArchiveView in interface de.elo.client.comserver.IWorkspace

showCheckoutView

public void showCheckoutView()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.showCheckoutView
 

Specified by:

showCheckoutView in interface de.elo.client.comserver.IWorkspace

showClipboardView

public void showClipboardView()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.showClipboardView
 

Specified by:

showClipboardView in interface de.elo.client.comserver.IWorkspace

showIntrayView

public void showIntrayView()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.showIntrayView
 

Specified by:

showIntrayView in interface de.elo.client.comserver.IWorkspace

showSearchView

public void showSearchView()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.showSearchView
 

Specified by:

showSearchView in interface de.elo.client.comserver.IWorkspace

startFunction

public void startFunction(com.jniwrapper.Int32 functionID)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.startFunction 44
 

Specified by:

startFunction in interface de.elo.client.comserver.IWorkspace

See Also:

Fct

startFunction

public void startFunction(com.jniwrapper.win32.automation.types.BStr functionName)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.startFunction IndexDialog
 

Specified by:

startFunction in interface de.elo.client.comserver.IWorkspace

See Also:

Fct

updateKeywords

public void updateKeywords()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.updateKeywords
 

Specified by:

updateKeywords in interface de.elo.client.comserver.IWorkspace

updateMasks

public void updateMasks()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.updateMasks
 

Specified by:

updateMasks in interface de.elo.client.comserver.IWorkspace

updateUsers

public void updateUsers()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.updateUsers
 

Specified by:

updateUsers in interface de.elo.client.comserver.IWorkspace

switchToArchive

public com.jniwrapper.Int32 switchToArchive(com.jniwrapper.win32.automation.types.BStr archiveName)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 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 de.elo.client.comserver.IWorkspace

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 com.jniwrapper.win32.automation.types.BStr getArchiveName()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 name = Elo.getArchiveName
 

Specified by:

getArchiveName in interface de.elo.client.comserver.IWorkspace

getArchiveLocation

public com.jniwrapper.win32.automation.types.BStr getArchiveLocation()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 location = Elo.getArchiveLocation
 

Specified by:

getArchiveLocation in interface de.elo.client.comserver.IWorkspace

getDelimiter

public com.jniwrapper.win32.automation.types.BStr getDelimiter()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 delimiter = Elo.getDelimiter
 

Specified by:

getDelimiter in interface de.elo.client.comserver.IWorkspace

minimize

public void minimize()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 Elo.mimimize
 

Specified by:

minimize in interface de.elo.client.comserver.IWorkspace

getActiveView

public com.jniwrapper.Int32 getActiveView()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 view = Elo.getActiveView
 

Specified by:

getActiveView in interface de.elo.client.comserver.IWorkspace

Returns:

Code für die momentan aktive Ansicht:

• 0 (keine Ansicht)
• 1 Archivansicht
• 2 Postbox
• 3 Klemmbrett
• 4 Suche
• 5 In Bearbeitung
• 6 Aufgaben

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

toFront

public void toFront()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 Elo.toFront
 

Specified by:

toFront in interface de.elo.client.comserver.IWorkspace

runScriptFunction

public com.jniwrapper.Int32 runScriptFunction(com.jniwrapper.win32.automation.types.BStr functionName,
                                              com.jniwrapper.win32.automation.types.BStr parameters)

Description copied from interface: de.elo.client.comserver.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 de.elo.client.comserver.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:

• -1: Script nicht gefunden
• -2: Fehler im Script (Exception)
• -3: Unspezifischer Fehler, z. B. bei der Validierung (eloCom)
• Sonst: Return-Wert der JavaScript Funktion

getVersion

public com.jniwrapper.win32.automation.types.BStr getVersion()

Description copied from interface: de.elo.client.comserver.IWorkspace

Liefert die aktuelle Versionsnummer des Java Clients.

Specified by:

getVersion in interface de.elo.client.comserver.IWorkspace

Returns:

ARCHIVE_NOT_FOUND

public com.jniwrapper.Int32 ARCHIVE_NOT_FOUND()

Description copied from interface: de.elo.client.comserver.IWorkspace

Konstante: Das Archiv wurde nicht gefunden

Specified by:

ARCHIVE_NOT_FOUND in interface de.elo.client.comserver.IWorkspace

COULD_NOT_CONNECT

public com.jniwrapper.Int32 COULD_NOT_CONNECT()

Description copied from interface: de.elo.client.comserver.IWorkspace

Konstante: Verbindungsfehler

Specified by:

COULD_NOT_CONNECT in interface de.elo.client.comserver.IWorkspace

EXCEPTION

public com.jniwrapper.Int32 EXCEPTION()

Description copied from interface: de.elo.client.comserver.IWorkspace

Konstante: Eine Exception ist aufgetreten

Specified by:

EXCEPTION in interface de.elo.client.comserver.IWorkspace

OK

public com.jniwrapper.Int32 OK()

Description copied from interface: de.elo.client.comserver.IWorkspace

Konstante: Alles OK

Specified by:

OK in interface de.elo.client.comserver.IWorkspace

clear

public void clear()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.clear
 

Specified by:

clear in interface de.elo.client.comserver.IPreview

deactivate

public void deactivate()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.deactivate
 

Specified by:

deactivate in interface de.elo.client.comserver.IPreview

reactivate

public void reactivate()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.showId 12345
 Elo.deactivate
 ...
 ...
 Elo.reactivate
 

Specified by:

reactivate in interface de.elo.client.comserver.IPreview

showId

public void showId(com.jniwrapper.Int32 id)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.showId 1198436
 

Specified by:

showId in interface de.elo.client.comserver.IPreview

Parameters:

id - Objekt Id des Sord Objekts

displayLocalFile

public void displayLocalFile(com.jniwrapper.win32.automation.types.BStr fileName)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.displayLocalFile "C:/foo/bar/test.txt"
 

Specified by:

displayLocalFile in interface de.elo.client.comserver.IPreview

Parameters:

fileName - Pfad der Datei die angezeigt werden soll

addAttachmentToSelectedDocument

public com.jniwrapper.win32.automation.types.VariantBool addAttachmentToSelectedDocument(com.jniwrapper.win32.automation.types.BStr attachmentFilePath)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 Elo.addAttachmentToSelectedDocument "C:/foo/bar/attachment.txt"
 

Specified by:

addAttachmentToSelectedDocument in interface de.elo.client.comserver.IDocument

Parameters:

attachmentFilePath - Dateipfad zu der Dateianbindung (Attachment)

Returns:

True, falls keine Exception aufgetreten ist

checkInSelectedDocument

public void checkInSelectedDocument()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument in ausgechecktem Zustand
 Elo.checkInSelectedDocument
 

Specified by:

checkInSelectedDocument in interface de.elo.client.comserver.IDocument

checkOutSelectedDocument

public void checkOutSelectedDocument()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument in eingechecktem Zustand
 Elo.checkOutSelectedDocument
 

Specified by:

checkOutSelectedDocument in interface de.elo.client.comserver.IDocument

checkOutDocument

public com.jniwrapper.win32.automation.types.BStr checkOutDocument(com.jniwrapper.Int32 documentId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 path = Elo.checkOutDocument(1198436)
 

Specified by:

checkOutDocument in interface de.elo.client.comserver.IDocument

Parameters:

documentId - Objekt Id des Archivobjekts

Returns:

Dateipfad des ausgecheckten Dokuments

openSelectedDocument

public void openSelectedDocument()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 Elo.openSelectedDocument
 

Specified by:

openSelectedDocument in interface de.elo.client.comserver.IDocument

printSelectedDocument

public void printSelectedDocument()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 Elo.printSelectedDocument
 

Specified by:

printSelectedDocument in interface de.elo.client.comserver.IDocument

sendSelectedDocument

public com.jniwrapper.win32.automation.types.VariantBool sendSelectedDocument(com.jniwrapper.win32.automation.types.BStr receiverMailAddress)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 Elo.sendSelectedDocument "foo@bar.com"
 

Specified by:

sendSelectedDocument in interface de.elo.client.comserver.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: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument mit Dateianbindung
 Elo.activateAttachmentOfSelectedDocument
 

Specified by:

activateAttachmentOfSelectedDocument in interface de.elo.client.comserver.IDocument

getSelectedDocumentId

public com.jniwrapper.Int32 getSelectedDocumentId()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 documentId = Elo.getSelectedDocumentId
 

Specified by:

getSelectedDocumentId in interface de.elo.client.comserver.IDocument

getSelectedDocumentName

public com.jniwrapper.win32.automation.types.BStr getSelectedDocumentName()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument
 documentName = Elo.getSelectedDocumentName
 

Specified by:

getSelectedDocumentName in interface de.elo.client.comserver.IDocument

removeAttachmentOfSelectedDocument

public void removeAttachmentOfSelectedDocument()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1198436  'dies ist ein Dokument mit Dateianbindung
 Elo.removeAttachmentOfSelectedDocument
 

Specified by:

removeAttachmentOfSelectedDocument in interface de.elo.client.comserver.IDocument

checkInDocument

public com.jniwrapper.Int32 checkInDocument(com.jniwrapper.win32.automation.types.BStr absoluteFilePath,
                                            com.jniwrapper.win32.automation.types.BStr documentDate)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 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 de.elo.client.comserver.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 com.jniwrapper.Int32 getFileOrigin(com.jniwrapper.win32.automation.types.BStr absoluteFilePath)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 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 de.elo.client.comserver.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 com.jniwrapper.win32.automation.types.BStr createTempCopy(com.jniwrapper.Int32 objectId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 filePath = Elo.createTempCopy(23)   'C:/<xyz>/test.txt
 

Specified by:

createTempCopy in interface de.elo.client.comserver.IDocument

Parameters:

objectId - Objekt Id eines Dokuments im geöffneten Archiv

Returns:

Dateipfad der Kopie im lokalen Temp-Verzeichnis des Archivs

getMD5Hash

public com.jniwrapper.win32.automation.types.BStr getMD5Hash(com.jniwrapper.win32.automation.types.BStr filePath)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 hash = Elo.getMD5Hash("C:\log.txt")
 

Specified by:

getMD5Hash in interface de.elo.client.comserver.IDocument

Parameters:

filePath - Gültiger Dateipfad

Returns:

MD5 Hashwert

getLinks

public com.jniwrapper.win32.automation.types.BStr getLinks(com.jniwrapper.Int32 objectId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 links = Elo.getLinks(234234)   '1¶2¶3¶4
 

Specified by:

getLinks in interface de.elo.client.comserver.IDocument

Parameters:

objectId - Objekt Id eines existierenden Archivobjekts

Returns:

Objekt Ids der verlinkten Archivobjekte, getrennt durch ClientConstants.ELO_SEPARATOR

getAttachmentFilePaths

public com.jniwrapper.win32.automation.types.BStr getAttachmentFilePaths(com.jniwrapper.Int32 objectId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 attachments = Elo.getAttachmentFilePaths(234234)   '<pfad>¶<pfad>¶<pfad>
 

Specified by:

getAttachmentFilePaths in interface de.elo.client.comserver.IDocument

Parameters:

objectId - Objekt Id eines Dokuments im Archiv

Returns:

Pfade der Attachment Dateien

search

public com.jniwrapper.Int32 search(com.jniwrapper.win32.automation.types.BStr searchString)

Description copied from interface: de.elo.client.comserver.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.login(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

Nachbedingung: Die Suchergebnisse werden angezeigt.

Beispiel mit Visual Basic:

 set Elo = CreateObject("jniwrapper.elocomserver")
 Elo.login
 hits = Elo.search("foobar")
 

Specified by:

search in interface de.elo.client.comserver.ISearch

Parameters:

searchString - Suchwort

Returns:

Anzahl der Treffer

searchFulltext

public com.jniwrapper.Int32 searchFulltext(com.jniwrapper.win32.automation.types.BStr searchString)

Description copied from interface: de.elo.client.comserver.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.login(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

Nachbedingung: Die Suchergebnisse werden angezeigt.

Beispiel mit Visual Basic:

 set Elo = CreateObject("jniwrapper.elocomserver")
 Elo.login
 hits = Elo.searchFulltext("foobar")
 

Specified by:

searchFulltext in interface de.elo.client.comserver.ISearch

Parameters:

searchString - Suchwort

Returns:

Anzahl der Treffer

searchByDate

public com.jniwrapper.Int32 searchByDate(com.jniwrapper.win32.automation.types.BStr isoDate)

Description copied from interface: de.elo.client.comserver.ISearch

Sucht nach Dokumenten, die zu dem angegebenen Datum passen oder in dem angegebenen Zeitraum liegen.

Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

Nachbedingung: Die Suchergebnisse werden angezeigt.

Beispiel mit Visual Basic:

 set Elo = CreateObject("jniwrapper.elocomserver")
 Elo.login
 hits = Elo.searchByDate("foobar")
 

Specified by:

searchByDate in interface de.elo.client.comserver.ISearch

Parameters:

isoDate - ISO Suchdatum oder Zeitraum

Returns:

Anzahl der Treffer

searchByNotes

public com.jniwrapper.Int32 searchByNotes(com.jniwrapper.win32.automation.types.BStr searchString)

Description copied from interface: de.elo.client.comserver.ISearch

Sucht nach Dokumenten, die eine Haftnotiz mit dem angegebenen Text enthalten.

Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

Nachbedingung: Die Suchergebnisse werden angezeigt.

Beispiel mit Visual Basic:

 set Elo = CreateObject("jniwrapper.elocomserver")
 Elo.login
 hits = Elo.searchByNotes("foobar")
 

Specified by:

searchByNotes in interface de.elo.client.comserver.ISearch

Parameters:

searchString - Suchwort

Returns:

Anzahl der Treffer

sortSearchList

public void sortSearchList(com.jniwrapper.Int32 column,
                           com.jniwrapper.Int32 mode)

Description copied from interface: de.elo.client.comserver.ISearch

Sortiert die Liste/Tabelle mit den Suchergebnissen

Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(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("jniwrapper.elocomserver")
 Elo.login
 Elo.search "foobar"
 Elo.sortSearchList(1,0)
 

Specified by:

sortSearchList in interface de.elo.client.comserver.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.

See Also:

SortTableModel.sort(int, int), SortTableModel.ADD_SORT, SortTableModel.REMOVE_SORT, SortTableModel.INSERT_SORT

hasNext

public com.jniwrapper.win32.automation.types.VariantBool hasNext()

Description copied from interface: de.elo.client.comserver.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.login(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("jniwrapper.elocomserver")
 Elo.login ...
 Elo.search "foobar"
 while (Elo.hasNext())
     MsgBox Elo.nextName()
 wend
 

Specified by:

hasNext in interface de.elo.client.comserver.ISearch

Returns:

VariantBool.TRUE falls das letzte Element des Iterators noch nicht erreicht wurde.

nextObjectId

public com.jniwrapper.Int32 nextObjectId()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.search "foobar"
 while (Elo.hasNext())
     MsgBox Elo.nextObjectId()
 wend
 

Specified by:

nextObjectId in interface de.elo.client.comserver.ISearch

Returns:

Die Objekt Id für das nächste Element des Iterators

nextName

public com.jniwrapper.win32.automation.types.BStr nextName()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.search "foobar"
 while (Elo.hasNext())
     MsgBox Elo.nextName()
 wend
 

Specified by:

nextName in interface de.elo.client.comserver.ISearch

Returns:

Die Kurzbezeichnung für das nächste Element des Iterators

nextGuid

public com.jniwrapper.win32.automation.types.BStr nextGuid()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.search "foobar"
 while (Elo.hasNext())
     MsgBox Elo.nextGuid()
 wend
 

Specified by:

nextGuid in interface de.elo.client.comserver.ISearch

Returns:

Die GUID für das nächste Element des Iterators

showSearchDialog

public com.jniwrapper.win32.automation.types.VariantBool showSearchDialog()

Description copied from interface: de.elo.client.comserver.ISearch

Seiteneffekte: Der Suchdialog wird angezeigt

Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(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("jniwrapper.elocomserver")
 Elo.login ...
 Elo.showSearchDialog
 

Specified by:

showSearchDialog in interface de.elo.client.comserver.ISearch

Returns:

VariantBool.TRUE, falls kein Fehler aufgetreten ist

searchIds

public com.jniwrapper.Int32 searchIds(com.jniwrapper.win32.automation.types.BStr objectIds,
                                      com.jniwrapper.win32.automation.types.BStr searchViewTitle)

Description copied from interface: de.elo.client.comserver.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.login(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("jniwrapper.elocomserver")
 Elo.login ...
 result = Elo.searchIds("1¶2¶3¶4","Verlinkte Archivobjekte")
 

Specified by:

searchIds in interface de.elo.client.comserver.ISearch

Parameters:

objectIds - Objekt Ids, getrennt durch ELO_SEPARATOR

searchViewTitle - Titel der neu angelegten Suchansicht

Returns:

Anzahl der gefundenen Archivobjekte

searchByMD5Hash

public com.jniwrapper.Int32 searchByMD5Hash(com.jniwrapper.win32.automation.types.BStr md5Hash)

Description copied from interface: de.elo.client.comserver.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.login(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("jniwrapper.elocomserver")
 Elo.login ...
 result = Elo.searchByMD5Hash("C4140E6616E2715A32C1AC6EE79672C8")
 

Specified by:

searchByMD5Hash in interface de.elo.client.comserver.ISearch

Parameters:

md5Hash - MD5 Hash

Returns:

Anzahl der Suchergebnisse

commitMaskSearch

public com.jniwrapper.Int32 commitMaskSearch()

Description copied from interface: de.elo.client.comserver.ISearch

Startet die Maskensuche.

Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareMaskSearch()
 Elo.setMaskName("EMail")
 Elo.setMaskFieldValue("Von","Maus")
 Elo.setMaskFieldValue("An","Klaus")
 Elo.commitMaskSearch()
 

Specified by:

commitMaskSearch in interface de.elo.client.comserver.ISearch

Returns:

Anzahl der Suchergebnisse oder -1 im Fehlerfall

setMaskFieldValue

public com.jniwrapper.win32.automation.types.VariantBool setMaskFieldValue(com.jniwrapper.win32.automation.types.BStr maskFieldName,
                                                                           com.jniwrapper.win32.automation.types.BStr maskFieldValue)

Description copied from interface: de.elo.client.comserver.ISearch

Setzt ein Maskenfeld der Suchmaske auf einen bestimmten Wert.

Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareMaskSearch()
 Elo.setMaskName("EMail")
 Elo.setMaskFieldValue("Von","Maus")
 Elo.setMaskFieldValue("An","Klaus")
 Elo.commitMaskSearch()
 

Specified by:

setMaskFieldValue in interface de.elo.client.comserver.ISearch

Parameters:

maskFieldName - Name des Maskenfeldes

maskFieldValue - Wert des Maskenfeldes

Returns:

VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist

setMaskName

public com.jniwrapper.win32.automation.types.VariantBool setMaskName(com.jniwrapper.win32.automation.types.BStr maskName)

Description copied from interface: de.elo.client.comserver.ISearch

Für die Suche wird die Maske mit dem angegebenen Maskennamen verwendet.

Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareMaskSearch()
 Elo.setMaskName("EMail")
 Elo.commitMaskSearch()
 

Specified by:

setMaskName in interface de.elo.client.comserver.ISearch

Parameters:

maskName - Name der Maske

Returns:

VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist

prepareMaskSearch

public com.jniwrapper.win32.automation.types.VariantBool prepareMaskSearch()

Description copied from interface: de.elo.client.comserver.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.login(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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareMaskSearch()
 Elo.setMaskName("EMail")
 Elo.setMaskFieldValue("Von","Maus")
 Elo.setMaskFieldValue("An","Klaus")
 Elo.commitMaskSearch()
 

Specified by:

prepareMaskSearch in interface de.elo.client.comserver.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 com.jniwrapper.Int32 searchByIndex(com.jniwrapper.win32.automation.types.BStr fieldGroupName,
                                          com.jniwrapper.win32.automation.types.BStr searchString)

Description copied from interface: de.elo.client.comserver.ISearch

Maskenübergreifende Suche in einem Indexfeld

Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.searchByIndex "An","Klaus"
 

Specified by:

searchByIndex in interface de.elo.client.comserver.ISearch

Parameters:

fieldGroupName - Indexfeld

searchString - Suchwort

Returns:

Anzahl der Suchergebnisse oder -1 im Fehlerfall

getSelectedObjectGUID

public com.jniwrapper.win32.automation.types.BStr getSelectedObjectGUID()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login
  Elo.gotoObjectId 1245753
  guid = Elo.getSelectedObjectGUID
 

Specified by:

getSelectedObjectGUID in interface de.elo.client.comserver.IArchivedObject

Returns:

GUID des selektierten Objekts

getSelectedObjectId

public com.jniwrapper.Int32 getSelectedObjectId()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login
  Elo.gotoObjectId 1245753
  objectId = Elo.getSelectedObjectId
 

Specified by:

getSelectedObjectId in interface de.elo.client.comserver.IArchivedObject

Returns:

Objekt Id des selektierten Objekts

getSelectedObjectParentId

public com.jniwrapper.Int32 getSelectedObjectParentId()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login
  Elo.gotoObjectId 1245753
  objectId = Elo.getSelectedObjectParentId
 

Specified by:

getSelectedObjectParentId in interface de.elo.client.comserver.IArchivedObject

Returns:

Parent Id des selektierten Objekts

getSelectedObjectName

public com.jniwrapper.win32.automation.types.BStr getSelectedObjectName()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login
  Elo.gotoObjectId 1245753
  name = Elo.getSelectedObjectName
 

Specified by:

getSelectedObjectName in interface de.elo.client.comserver.IArchivedObject

Returns:

Name des selektierten Objekts

getSelectedObjectType

public com.jniwrapper.Int32 getSelectedObjectType()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login
  Elo.gotoObjectId 1245753
  type = Elo.getSelectedObjectType
 

Specified by:

getSelectedObjectType in interface de.elo.client.comserver.IArchivedObject

Returns:

Typ des selektierten Objekts

getSelectedObjectChildCount

public com.jniwrapper.Int32 getSelectedObjectChildCount()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1245753
 childCount = Elo.getSelectedObjectChildCount
 

Specified by:

getSelectedObjectChildCount in interface de.elo.client.comserver.IArchivedObject

Returns:

Anzahl der Kindknoten des selektierten Objekts

getSelectedObjectInternalIsoDate

public com.jniwrapper.win32.automation.types.BStr getSelectedObjectInternalIsoDate()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1245753
 internalDate = Elo.getSelectedObjectInternalIsoDate
 

Specified by:

getSelectedObjectInternalIsoDate in interface de.elo.client.comserver.IArchivedObject

Returns:

Das interne Datum (Ablagedatum) für ein selektiertes ArchivObjekt

getSelectedObjectExternalIsoDate

public com.jniwrapper.win32.automation.types.BStr getSelectedObjectExternalIsoDate()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 1245753
 externalDate = Elo.getSelectedObjectExternalIsoDate
 

Specified by:

getSelectedObjectExternalIsoDate in interface de.elo.client.comserver.IArchivedObject

Returns:

Das externe Datum (Dokumentendatum) für ein selektiertes ArchivObjekt

chooseTargetObject

public com.jniwrapper.Int32 chooseTargetObject(com.jniwrapper.Int32 mode,
                                               com.jniwrapper.win32.automation.types.BStr dialogTitle)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login ...
  objectId = Elo.chooseTargetObject(3,"Balu der Bär")
 

Specified by:

chooseTargetObject in interface de.elo.client.comserver.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 com.jniwrapper.win32.automation.types.BStr getObjectTreePath(com.jniwrapper.Int32 objectId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login ...
  objectTreePath = Elo.getObjectTreePath(32)
 

Specified by:

getObjectTreePath in interface de.elo.client.comserver.IArchivedObject

Returns:

Der Archivpfad des Archivobjekts, Pfadelemente getrennt durch ClientConstants.ELO_SEPARATOR

archivePathExists

public com.jniwrapper.win32.automation.types.VariantBool archivePathExists(com.jniwrapper.win32.automation.types.BStr archivePath)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login ...
  
  exists = Elo.archivePathExists("Testdateien¶MSG¶Foobar")
 

Specified by:

archivePathExists in interface de.elo.client.comserver.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 com.jniwrapper.Int32 getIdFromArchivePath(com.jniwrapper.win32.automation.types.BStr archivePath)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login ...
  id = Elo.getIdFromArchivePath("Testdateien¶MSG¶Foobar")
 

Specified by:

getIdFromArchivePath in interface de.elo.client.comserver.IArchivedObject

Parameters:

archivePath - Archivpfad ohne Archivname, getrennt durch ClientConstants.ELO_SEPARATOR

Returns:

Die Objekt Id des über den Archivpfad identifizierten Archivobjekts

getSubFolders

public com.jniwrapper.win32.automation.types.BStr getSubFolders(com.jniwrapper.win32.automation.types.BStr archivePath)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login ...
  subFolders = Elo.getSubFolders("Testdateien¶MSG¶Foobar")
 

Specified by:

getSubFolders in interface de.elo.client.comserver.IArchivedObject

Parameters:

archivePath - Archivpfad ohne Archivname, getrennt durch ClientConstants.ELO_SEPARATOR

Returns:

Die Namen der Unterverzeichnisse zu dem angegebenen Archivpfad

createSubFolder

public com.jniwrapper.win32.automation.types.VariantBool createSubFolder(com.jniwrapper.win32.automation.types.BStr archivePath,
                                                                         com.jniwrapper.win32.automation.types.BStr folderName)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login ...
  success1 = Elo.createSubFolder("Testdateien¶MSG¶Foobar","FolderName")
  success2 = Elo.createSubFolder("","FolderName")
 

Specified by:

createSubFolder in interface de.elo.client.comserver.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 com.jniwrapper.win32.automation.types.VariantBool makeLink(com.jniwrapper.Int32 sourceObjectId,
                                                                  com.jniwrapper.Int32 destinationObjectId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login ...
  success = Elo.makeLink(245,23)
 

Specified by:

makeLink in interface de.elo.client.comserver.IArchivedObject

Parameters:

sourceObjectId - Objekt Id des Quellobjekts

destinationObjectId - Objekt Id des Zielobjekts

Returns:

VariantBool.TRUE falls das Verlinken erfolgreich war

getObjectMaskId

public com.jniwrapper.Int32 getObjectMaskId(com.jniwrapper.Int32 objectId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login ...
  maskId = Elo.getObjectMaskId(23)
 

Specified by:

getObjectMaskId in interface de.elo.client.comserver.IArchivedObject

Parameters:

objectId - Objekt Id eines Archivobjekts

Returns:

Masken Id des Archivobjekts

createReference

public com.jniwrapper.win32.automation.types.VariantBool createReference(com.jniwrapper.Int32 objectId,
                                                                         com.jniwrapper.Int32 newParentId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
  Elo.login ...
  success = Elo.createReference(123,456)
 

Specified by:

createReference in interface de.elo.client.comserver.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

getUserName

public com.jniwrapper.win32.automation.types.BStr getUserName(com.jniwrapper.Int32 userId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 userName = Elo.getUserName(0)
 

Specified by:

getUserName in interface de.elo.client.comserver.IUser

Parameters:

userId - Id eines existierenden Benutzers

Returns:

Benutzername

userNameExists

public com.jniwrapper.win32.automation.types.VariantBool userNameExists(com.jniwrapper.win32.automation.types.BStr userName)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 if Elo.userNameExists("Blaubarschbube") then
     doSomething
 end if
 

Specified by:

userNameExists in interface de.elo.client.comserver.IUser

Parameters:

userName - Benutzername eines existierenden Benutzers

Returns:

True, falls ein Benutzer mit dem angegebenen Benutzernamen existiert.

userIdExists

public com.jniwrapper.win32.automation.types.VariantBool userIdExists(com.jniwrapper.Int32 userId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 if Elo.userIdExists(0) then
     doSomething
 end if
 

Specified by:

userIdExists in interface de.elo.client.comserver.IUser

Parameters:

userId - Id eines existierenden Benutzers

Returns:

True, falls ein Benutzer mit der angegebenen Benutzer Id existiert.

getUserNames

public com.jniwrapper.win32.automation.types.BStr getUserNames()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 userNames = Elo.getUserNames
 

Specified by:

getUserNames in interface de.elo.client.comserver.IUser

Returns:

Alle Benutzernamen

getGroupNames

public com.jniwrapper.win32.automation.types.BStr getGroupNames()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 groupNames = Elo.getGroupNames
 

Specified by:

getGroupNames in interface de.elo.client.comserver.IUser

Returns:

Alle Gruppennamen

getSelectedIntrayFile

public com.jniwrapper.win32.automation.types.BStr getSelectedIntrayFile()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.selectIntrayRow 0
 filePath = Elo.getSelectedIntrayFile
 

Specified by:

getSelectedIntrayFile in interface de.elo.client.comserver.IIntray

selectAllIntrayRows

public void selectAllIntrayRows()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.selectAllIntrayRows
 

Specified by:

selectAllIntrayRows in interface de.elo.client.comserver.IIntray

selectIntrayRow

public void selectIntrayRow(com.jniwrapper.Int32 index)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.selectIntrayRow 0
 

Specified by:

selectIntrayRow in interface de.elo.client.comserver.IIntray

Parameters:

index - Index der Zeile die selektiert wird

unselectAllIntrayRows

public void unselectAllIntrayRows()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.unselectAllIntrayRows
 

Specified by:

unselectAllIntrayRows in interface de.elo.client.comserver.IIntray

scanSinglePage

public void scanSinglePage()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.scanSinglePage
 

Specified by:

scanSinglePage in interface de.elo.client.comserver.IIntray

scanMultiPage

public void scanMultiPage()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.scanMultiPage
 

Specified by:

scanMultiPage in interface de.elo.client.comserver.IIntray

getNumberOfIntrayFiles

public com.jniwrapper.Int32 getNumberOfIntrayFiles()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 files = Elo.getNumberOfIntrayFiles
 

Specified by:

getNumberOfIntrayFiles in interface de.elo.client.comserver.IIntray

Returns:

Die Anzahl der Dateien in der Postbox

addDocumentFileToArchive

public com.jniwrapper.Int32 addDocumentFileToArchive(com.jniwrapper.win32.automation.types.BStr absoluteFilePath,
                                                     com.jniwrapper.win32.automation.types.BStr documentName,
                                                     com.jniwrapper.win32.automation.types.BStr documentDate)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.addDocumentFileToArchive "C:/foo/bar.txt", "Strategie für 2008", "20071010130000"
 

Specified by:

addDocumentFileToArchive in interface de.elo.client.comserver.IIntray

Parameters:

absoluteFilePath - Quellpfad der Dokumenten Datei

documentName - Kurzbezeichnung

documentDate - Dokumentendatum yyyyMMddHHmmss

Returns:

Objekt Id des neuen Archivdokuments oder -1

addDocumentFileToParent

public com.jniwrapper.Int32 addDocumentFileToParent(com.jniwrapper.Int32 parentObjectId,
                                                    com.jniwrapper.win32.automation.types.BStr absoluteFilePath,
                                                    com.jniwrapper.win32.automation.types.BStr documentName,
                                                    com.jniwrapper.win32.automation.types.BStr documentDate)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.addDocumentFileToParent 1, "C:/foo/bar.txt", "Strategie für 2008", "20071010130000"
 

Specified by:

addDocumentFileToParent in interface de.elo.client.comserver.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 com.jniwrapper.win32.automation.types.BStr addDocumentFileToIntray(com.jniwrapper.win32.automation.types.BStr absoluteFilePath)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 Elo.addDocumentFileToIntray "C:/foo/bar.txt"
 

Specified by:

addDocumentFileToIntray in interface de.elo.client.comserver.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 com.jniwrapper.Int32 addDocumentFileToArchivePath(com.jniwrapper.win32.automation.types.BStr documentFilePath,
                                                         com.jniwrapper.win32.automation.types.BStr documentName,
                                                         com.jniwrapper.win32.automation.types.BStr documentDate,
                                                         com.jniwrapper.win32.automation.types.BStr archivePath)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.addDocumentFileToArchivePath "C:/foo/bar.txt", "FooBar", "20071010130000", "Foo¶Bar¶Baz"
 

Specified by:

addDocumentFileToArchivePath in interface de.elo.client.comserver.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(com.jniwrapper.win32.automation.types.VariantBool showIndexDialog)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 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 de.elo.client.comserver.IIntray

Parameters:

showIndexDialog - VariantBool.TRUE, falls der Indexdialog beim Aufruf einer der angegebenen Methoden angezeigt werden soll

See Also:

IIntray.addDocumentFileToArchive(BStr, BStr, BStr), IIntray.addDocumentFileToArchivePath(BStr, BStr, BStr, BStr), IIntray.addDocumentFileToParent(Int32, BStr, BStr, BStr)

addDocumentFileAsAttachment

public com.jniwrapper.win32.automation.types.VariantBool addDocumentFileAsAttachment(com.jniwrapper.win32.automation.types.BStr documentFilePath,
                                                                                     com.jniwrapper.Int32 targetObjectId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 success = Elo.addDocumentFileAsAttachment("D:\action.txt",23)
 

Specified by:

addDocumentFileAsAttachment in interface de.elo.client.comserver.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

setIndexFieldInIntray

public com.jniwrapper.win32.automation.types.VariantBool setIndexFieldInIntray(com.jniwrapper.win32.automation.types.BStr documentFilePath,
                                                                               com.jniwrapper.Int32 maskId,
                                                                               com.jniwrapper.Int32 fieldId,
                                                                               com.jniwrapper.win32.automation.types.BStr fieldValue)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 success = Elo.setIndexFieldInIntray("action.txt",3,2,"foobar")
 

Specified by:

setIndexFieldInIntray in interface de.elo.client.comserver.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

setNameInIntray

public com.jniwrapper.win32.automation.types.VariantBool setNameInIntray(com.jniwrapper.win32.automation.types.BStr documentFileName,
                                                                         com.jniwrapper.win32.automation.types.BStr name)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 success = Elo.setNameInIntray("action.txt","foobar")
 

Specified by:

setNameInIntray in interface de.elo.client.comserver.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

setDateInIntray

public com.jniwrapper.win32.automation.types.VariantBool setDateInIntray(com.jniwrapper.win32.automation.types.BStr documentFileName,
                                                                         com.jniwrapper.win32.automation.types.BStr date)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 success = Elo.setDateInIntray("action.txt","20080814142700")
 

Specified by:

setDateInIntray in interface de.elo.client.comserver.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

selectIntrayFiles

public com.jniwrapper.win32.automation.types.VariantBool selectIntrayFiles(com.jniwrapper.win32.automation.types.BStr files)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 success = Elo.selectIntrayFiles("foo.txt¶bar.txt¶baz.txt")
 

Specified by:

selectIntrayFiles in interface de.elo.client.comserver.IIntray

Parameters:

files - Dateinamen, getrennt durch ELO_SEPARATOR ¶

Returns:

VariantBool.TRUE falls die Vorbedingung erfüllt ist und kein Fehler aufgetreten ist

getIntrayDirectoryPath

public com.jniwrapper.win32.automation.types.BStr getIntrayDirectoryPath()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 intrayDir = Elo.getIntrayDirectoryPath
 

Specified by:

getIntrayDirectoryPath in interface de.elo.client.comserver.IIntray

Returns:

Absoluter Dateipfad für das Postboxverzeichnis

refreshIntray

public com.jniwrapper.win32.automation.types.VariantBool refreshIntray()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 Elo.refreshIntray();
 

Specified by:

refreshIntray in interface de.elo.client.comserver.IIntray

Returns:

VariantBool.TRUE, falls kein Fehler aufgetreten ist

goBackward

public void goBackward()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 123
 Elo.gotoObjectId 456
 Elo.goBackward
 

Specified by:

goBackward in interface de.elo.client.comserver.INavigation

goForward

public void goForward()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 Elo.gotoObjectId 123
 Elo.gotoObjectId 456
 Elo.goBackward
 Elo.goForward
 

Specified by:

goForward in interface de.elo.client.comserver.INavigation

getReminderName

public com.jniwrapper.win32.automation.types.BStr getReminderName()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 MsgBox Elo.getReminderName
 

Specified by:

getReminderName in interface de.elo.client.comserver.IReminder

setReminderName

public void setReminderName(com.jniwrapper.win32.automation.types.BStr name)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 Elo.setReminderName "foo"
 

Specified by:

setReminderName in interface de.elo.client.comserver.IReminder

getReminderCreateDate

public com.jniwrapper.win32.automation.types.BStr getReminderCreateDate()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 MsgBox Elo.getReminderCreateDate
 

Specified by:

getReminderCreateDate in interface de.elo.client.comserver.IReminder

getReminderDescription

public com.jniwrapper.win32.automation.types.BStr getReminderDescription()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 MsgBox Elo.getReminderDescription
 

Specified by:

getReminderDescription in interface de.elo.client.comserver.IReminder

getReminderPromptDate

public com.jniwrapper.win32.automation.types.BStr getReminderPromptDate()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 MsgBox Elo.getReminderPromptDate  'z. B. 20071205135400
 

Specified by:

getReminderPromptDate in interface de.elo.client.comserver.IReminder

getReminderSenderId

public com.jniwrapper.Int32 getReminderSenderId()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 MsgBox Elo.getReminderSenderId
 

Specified by:

getReminderSenderId in interface de.elo.client.comserver.IReminder

getReminderReceiverId

public com.jniwrapper.Int32 getReminderReceiverId()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 MsgBox Elo.getReminderReceiverId
 

Specified by:

getReminderReceiverId in interface de.elo.client.comserver.IReminder

getReminderPriority

public com.jniwrapper.Int32 getReminderPriority()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 MsgBox Elo.getReminderPriority
 

Specified by:

getReminderPriority in interface de.elo.client.comserver.IReminder

setReminderCreateDate

public void setReminderCreateDate(com.jniwrapper.win32.automation.types.BStr createDate)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 Elo.setReminderCreateDate 20071105
 

Specified by:

setReminderCreateDate in interface de.elo.client.comserver.IReminder

setReminderDescription

public void setReminderDescription(com.jniwrapper.win32.automation.types.BStr description)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 Elo.setReminderDescription "Lorem ipsum dolor sit amet"
 

Specified by:

setReminderDescription in interface de.elo.client.comserver.IReminder

setReminderPromptDate

public void setReminderPromptDate(com.jniwrapper.win32.automation.types.BStr date)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 Elo.setReminderPromptDate 20091010140000   'somewhere in the future
 

Specified by:

setReminderPromptDate in interface de.elo.client.comserver.IReminder

setReminderSenderId

public void setReminderSenderId(com.jniwrapper.Int32 fromUserId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 Elo.setReminderSenderId 33
 

Specified by:

setReminderSenderId in interface de.elo.client.comserver.IReminder

setReminderReceiverId

public void setReminderReceiverId(com.jniwrapper.Int32 ownerUserId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 Elo.setReminderReceiverId 32
 

Specified by:

setReminderReceiverId in interface de.elo.client.comserver.IReminder

setReminderPriority

public void setReminderPriority(com.jniwrapper.Int32 priority)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 Elo.setReminderPriority 0
 

Specified by:

setReminderPriority in interface de.elo.client.comserver.IReminder

createNewReminder

public com.jniwrapper.Int32 createNewReminder(com.jniwrapper.Int32 objectId,
                                              com.jniwrapper.win32.automation.types.BStr receiverIds,
                                              com.jniwrapper.win32.automation.types.BStr name,
                                              com.jniwrapper.win32.automation.types.BStr message)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 Elo.createNewReminder 1198436, "11¶12¶13", "tester", "dies ist ein test"
 

Specified by:

createNewReminder in interface de.elo.client.comserver.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 com.jniwrapper.win32.automation.types.VariantBool gotoReminder(com.jniwrapper.Int32 reminderId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login
 ...
 Elo.gotoReminder(23)
 

Specified by:

gotoReminder in interface de.elo.client.comserver.IReminder

Parameters:

reminderId - Id des Wiedervorlage Objekts

Returns:

VariantBool.TRUE, falls kein Fehler aufgetreten ist

getMaskIds

public com.jniwrapper.win32.automation.types.BStr getMaskIds()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 maskIds = Elo.getMaskIds
 

Specified by:

getMaskIds in interface de.elo.client.comserver.IMask

Returns:

Die Objekt Ids aller Masken des aktiven Archivs

getMaskNames

public com.jniwrapper.win32.automation.types.BStr getMaskNames()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 maskNames = Elo.getMaskNames
 

Specified by:

getMaskNames in interface de.elo.client.comserver.IMask

Returns:

Alle Maskennamen

getMaskFields

public com.jniwrapper.win32.automation.types.BStr getMaskFields(com.jniwrapper.Int32 maskId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 
 maskFields = Elo.getMaskFields(20)   'Foo¶Bar¶Baz
 

Specified by:

getMaskFields in interface de.elo.client.comserver.IMask

Returns:

Die Maskenfelder der Maske mit der angegebenen Masken Id, getrennt durch ELO_SEPARATOR

getMaskNamesAndIds

public com.jniwrapper.win32.automation.types.BStr getMaskNamesAndIds()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 maskNamesAndIds = Elo.getMaskNamesAndIds
 

Specified by:

getMaskNamesAndIds in interface de.elo.client.comserver.IMask

Returns:

Die Maskennamen und Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.

commitObject

public com.jniwrapper.win32.automation.types.VariantBool commitObject()

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareObject(12345)
 Elo.set...
 Elo.set...
 Elo.set...
 Elo.set...
 Elo.commitObject
 

Specified by:

commitObject in interface de.elo.client.comserver.IObjectProperties

Returns:

VariantBool.TRUE, falls kein Fehler aufgetreten ist

prepareObject

public com.jniwrapper.win32.automation.types.VariantBool prepareObject(com.jniwrapper.Int32 objectId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareObject(12345)
 Elo.set...
 Elo.set...
 Elo.set...
 Elo.set...
 Elo.commitObject
 

Specified by:

prepareObject in interface de.elo.client.comserver.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 com.jniwrapper.win32.automation.types.VariantBool setIndexField(com.jniwrapper.Int32 fieldId,
                                                                       com.jniwrapper.win32.automation.types.BStr fieldValue)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareObject(12345)
 Elo.setIndexField 7,"Bar"
 Elo.commitObject
 

Specified by:

setIndexField in interface de.elo.client.comserver.IObjectProperties

Parameters:

fieldId - Id des Indexfelds

fieldValue - Neuer Wert des Indexfelds

Returns:

VariantBool.TRUE, falls kein Fehler aufgetreten ist

setMaskId

public com.jniwrapper.win32.automation.types.VariantBool setMaskId(com.jniwrapper.Int32 maskId)

Description copied from interface: de.elo.client.comserver.ISearch

Für die Suche wird die Maske mit der angegebenen Masken Id verwendet.

Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login(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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareMaskSearch()
 Elo.setMaskId(123)
 Elo.setMaskFieldValue("Von","Maus")
 Elo.setMaskFieldValue("An","Klaus")
 Elo.commitMaskSearch()
 

Specified by:

setMaskId in interface de.elo.client.comserver.IObjectProperties

Specified by:

setMaskId in interface de.elo.client.comserver.ISearch

Parameters:

maskId - Masken Id für die Suchmaske

Returns:

VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist

setDescription

public com.jniwrapper.win32.automation.types.VariantBool setDescription(com.jniwrapper.win32.automation.types.BStr description)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareObject(12345)
 Elo.setDescription "Beschreibungstext"
 Elo.commitObject
 

Specified by:

setDescription in interface de.elo.client.comserver.IObjectProperties

Parameters:

description - Memo Text

Returns:

VariantBool.TRUE, falls kein Fehler aufgetreten ist

setName

public com.jniwrapper.win32.automation.types.VariantBool setName(com.jniwrapper.win32.automation.types.BStr name)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareObject(12345)
 Elo.setName "Foo"
 Elo.commitObject
 

Specified by:

setName in interface de.elo.client.comserver.IObjectProperties

Parameters:

name - Name bzw. Kurzbezeichnung für das Archivobjekt

Returns:

VariantBool.TRUE, falls kein Fehler aufgetreten ist

getIndexField

public com.jniwrapper.win32.automation.types.BStr getIndexField(com.jniwrapper.Int32 objectId,
                                                                com.jniwrapper.Int32 fieldId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 
 fieldValue = Elo.getIndexField(2,3)
 

Specified by:

getIndexField in interface de.elo.client.comserver.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

getObjAcl

public com.jniwrapper.win32.automation.types.BStr getObjAcl(com.jniwrapper.Int32 objectId)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 
 acl = Elo.getObjAcl(487549)
 

Specified by:

getObjAcl in interface de.elo.client.comserver.IObjectProperties

Parameters:

objectId - Objekt Id eines Archivobjekts

Returns:

Codierte Access Control List ACL

setObjAcl

public com.jniwrapper.win32.automation.types.VariantBool setObjAcl(com.jniwrapper.win32.automation.types.BStr aclString)

Description copied from interface: de.elo.client.comserver.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("jniwrapper.elocomserver")
 Elo.login ...
 
 Elo.prepareObject(487549)
 success = Elo.setObjAcl("K2,R3,RW4,RWDE5")
 Elo.commitObject()
 

Specified by:

setObjAcl in interface de.elo.client.comserver.IObjectProperties

Parameters:

aclString - Wohlgeformter ACL String, siehe oben

Returns:

VariantBool.TRUE bei Erfolg