Package de.elo.client.comserver

Interface IArchivedObject

All Superinterfaces:

AutoDeleteParameter, IDispatch, IUnknown

All Known Implementing Classes:

EloComServer

public interface IArchivedObject
extends IDispatch

Überschrift: IArchivedObject

Beschreibung: COM-Schnittstelle für Dokumente und Strukturelemente, früher auch SORD Objekte genannt (Schränke, Ordner, Register, Dokumente).

Copyright: Copyright (c) ELO Digital Office GmbH 2007

Field Summary

Fields

Modifier and Type	Field	Description
static String	INTERFACE_IDENTIFIER	IID für ComfyJ

Method Summary

Modifier and Type	Method	Description
VariantBool	archivePathExists(BStr archivePath)	VariantBool.TRUE, falls der angegebene Archivpfad im aktuell geöffneten Archiv vorhanden ist.
Int32	chooseTargetObject(Int32 mode, BStr dialogTitle)	Der TreeSelectDialog wird angezeigt.
VariantBool	createReference(Int32 objectId, Int32 newParentId)	Erzeugt eine Referenz für ein Archivobjekt in einem Archivordner.
VariantBool	createSubFolder(BStr archivePath, BStr folderName)	Erstellt einen neuen Unterordner unterhalb des angegebenen Archivpfades.
Int32	getIdFromArchivePath(BStr archivePath)	Liefert die Objekt Id eines Archivobjekts, welches über den angegebenen Archivpfad identifiziert wird.
Int32	getObjectMaskId(Int32 objectId)	Liefert die Masken Id des Archivobjekts mit der angegebenen Objekt Id
BStr	getObjectTreePath(Int32 objectId)	Liefert den Pfad des Archivobjekts im Archivbaum.
Int32	getSelectedObjectChildCount()	Liefert die Anzahl der Kindknoten eines im Archiv/Klemmbrett selektierten Objekts.
BStr	getSelectedObjectExternalIsoDate()	Liefert das externe Datum (Dokumentendatum) für ein selektiertes ArchivObjekt.
BStr	getSelectedObjectGUID()	Liefert die GUID eines im Archiv/Klemmbrett selektierten Objekts.
Int32	getSelectedObjectId()	Liefert die Objekt Id eines im Archiv/Klemmbrett selektierten Objekts.
BStr	getSelectedObjectInternalIsoDate()	Liefert das interne Datum (Ablagedatum) für ein selektiertes ArchivObjekt.
BStr	getSelectedObjectName()	Liefert die Kurzbezeichnung eines im Archiv/Klemmbrett selektierten Objekts.
Int32	getSelectedObjectParentId()	Liefert die Parent Id eines im Archiv/Klemmbrett selektierten Objekts.
Int32	getSelectedObjectType()	Liefert den Typ eines im Archiv/Klemmbrett selektierten Objekts.
BStr	getSubFolders(BStr archivePath)	Liefert die Namen der Unterverzeichnisse zu dem angegebenen Archivpfad.
VariantBool	makeLink(Int32 sourceObjectId, Int32 destinationObjectId)	Seiteneffekte: Verlinkt das Quellobjekt (Source) mit dem Zielobjekt (Destination).

Methods inherited from interface AutoDeleteParameter

isAutoDelete, setAutoDelete

Methods inherited from interface IDispatch

getIDsOfNames, getTypeInfo, getTypeInfoCount, invoke

Methods inherited from interface IUnknown

addRef, isNull, queryInterface, release, setNull

Field Details

INTERFACE_IDENTIFIER

static final String INTERFACE_IDENTIFIER

IID für ComfyJ

See Also:

Constant Field Values

Method Details

getSelectedObjectGUID

BStr getSelectedObjectGUID()

Liefert die GUID eines im Archiv/Klemmbrett selektierten Objekts.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.

Nachbedingung: Die GUID des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.

Fehlerbehandlung: Wenn nichts selektiert wurde wird ein leerer String zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login
  Elo.gotoObjectId 1245753
  guid = Elo.getSelectedObjectGUID
 

Returns:

GUID des selektierten Objekts

getSelectedObjectId

Int32 getSelectedObjectId()

Liefert die Objekt Id eines im Archiv/Klemmbrett selektierten Objekts.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.

Nachbedingung: Die Objekt Id des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.

Fehlerbehandlung: Wenn nichts selektiert wurde wird -1 zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login
  Elo.gotoObjectId 1245753
  objectId = Elo.getSelectedObjectId
 

Returns:

Objekt Id des selektierten Objekts

getSelectedObjectName

BStr getSelectedObjectName()

Liefert die Kurzbezeichnung eines im Archiv/Klemmbrett selektierten Objekts.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.

Nachbedingung: Die Kurzbezeichnung des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.

Fehlerbehandlung: Wenn nichts selektiert wurde wird ein leerer String zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login
  Elo.gotoObjectId 1245753
  name = Elo.getSelectedObjectName
 

Returns:

Name des selektierten Objekts

getSelectedObjectType

Int32 getSelectedObjectType()

Liefert den Typ eines im Archiv/Klemmbrett selektierten Objekts.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.

Nachbedingung: Der Typ des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.

Fehlerbehandlung: Wenn nichts selektiert wurde wird -1 zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login
  Elo.gotoObjectId 1245753
  type = Elo.getSelectedObjectType
 

Returns:

Typ des selektierten Objekts

getSelectedObjectChildCount

Int32 getSelectedObjectChildCount()

Liefert die Anzahl der Kindknoten eines im Archiv/Klemmbrett selektierten Objekts. Bei Dokumenten ist dieser Wert Null.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.

Nachbedingung: Die Anzahl der Kindknoten des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.

Beispiel mit Visual Basic:

 set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1245753
 childCount = Elo.getSelectedObjectChildCount
 

Returns:

Anzahl der Kindknoten des selektierten Objekts

getSelectedObjectInternalIsoDate

BStr getSelectedObjectInternalIsoDate()

Liefert das interne Datum (Ablagedatum) für ein selektiertes ArchivObjekt.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.

Nachbedingung: Das interne Datum (Ablagedatum) für das selektierte ArchivObjekt wird zurückgegeben.

Fehlerbehandlung: Wenn nichts selektiert wurde wird ein leerer String zurückgeliefert.

Beispiel mit Visual Basic:

 set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1245753
 internalDate = Elo.getSelectedObjectInternalIsoDate
 

Returns:

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

getSelectedObjectExternalIsoDate

BStr getSelectedObjectExternalIsoDate()

Liefert das externe Datum (Dokumentendatum) für ein selektiertes ArchivObjekt.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.

Nachbedingung: Das externe Datum (Dokumentendatum) für das selektiertes ArchivObjekt wird zurückgegeben.

Fehlerbehandlung: Wenn nichts selektiert wurde wird ein leerer String zurückgeliefert.

Beispiel mit Visual Basic:

 set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.gotoObjectId 1245753
 externalDate = Elo.getSelectedObjectExternalIsoDate
 

Returns:

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

getSelectedObjectParentId

Int32 getSelectedObjectParentId()

Liefert die Parent Id eines im Archiv/Klemmbrett selektierten Objekts.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Im Archiv/Klemmbrett wurde ein Objekt ausgewählt.

Nachbedingung: Die Parent Id des im Archiv/Klemmbrett selektierten Objekts wird zurückgeliefert.

Fehlerbehandlung: Wenn nichts selektiert wurde wird -1 zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login
  Elo.gotoObjectId 1245753
  objectId = Elo.getSelectedObjectParentId
 

Returns:

Parent Id des selektierten Objekts

chooseTargetObject

Int32 chooseTargetObject(Int32 mode, BStr dialogTitle)

Der TreeSelectDialog wird angezeigt. Hier kann der Benutzer ein Archivobjekt auswählen. Die Objekt Id des gewählten Archivobjekts wird zurückgegeben.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Der Parameter mode hat einen der unten angegebenen Werte.

Nachbedingung: Die Objekt Id des gewählten Archivobjekts wird zurückgegeben. Falls der Benutzer auf Abbrechen geklickt hat wird -1 zurückgegeben.

Fehlerbehandlung: Im Fehlerfall wird -1 zurückgegeben.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login ...
  objectId = Elo.chooseTargetObject(3,"Balu der Bär")
 

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

BStr getObjectTreePath(Int32 objectId)

Liefert den Pfad des Archivobjekts im Archivbaum. Das Archivobjekt wird über die Objekt Id identifiziert. Der Archivpfad enthält ClientConstants.ELO_SEPARATOR als Trennzeichen.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Die Objekt Id eines existierenden Archivobjekts wird angegeben.

Nachbedingung: Der Archivpfad des Archivobjekts wird zurückgegeben.

Fehlerbehandlung: Falls zu der angegebenen Objekt Id kein Archivobjekt existiert wird ein leerer String zurückgeliefert. Falls ein anderer Fehler auftritt wird ein leerer String zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login ...
  objectTreePath = Elo.getObjectTreePath(32)
 

Parameters:

objectId - ObjektId

Returns:

Der Archivpfad des Archivobjekts, Pfadelemente getrennt durch ClientConstants.ELO_SEPARATOR

archivePathExists

VariantBool archivePathExists(BStr archivePath)

VariantBool.TRUE, falls der angegebene Archivpfad im aktuell geöffneten Archiv vorhanden ist.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet.

Nachbedingung: Falls der angegebene Archivpfad im aktuell geöffneten Archiv vorhanden ist wurde VariantBool.TRUE zurückgeliefert

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login ...
  
  exists = Elo.archivePathExists("Testdateien¶MSG¶Foobar")
 

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

Int32 getIdFromArchivePath(BStr archivePath)

Liefert die Objekt Id eines Archivobjekts, welches über den angegebenen Archivpfad identifiziert wird.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet.

Nachbedingung: Falls der angegebene Archivpfad im aktuell geöffneten Archiv vorhanden ist wird die Objekt Id des letzten Pfadobjekts zurückgeliefert.

Fehlerbehandlung: Wenn der Pfad nicht existiert wird -1 zurückgeliefert. Im Fehlerfall wird -1 zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login ...
  id = Elo.getIdFromArchivePath("Testdateien¶MSG¶Foobar")
 

Parameters:

archivePath - Archivpfad ohne Archivname, getrennt durch ClientConstants.ELO_SEPARATOR

Returns:

Die Objekt Id des über den Archivpfad identifizierten Archivobjekts

getSubFolders

BStr getSubFolders(BStr archivePath)

Liefert die Namen der Unterverzeichnisse zu dem angegebenen Archivpfad.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Der angegebene Archivpfad muss im aktuellen Archiv existieren und ein wohlgeformter Archivpfad sein.

Nachbedingung: Die Namen der Unterverzeichnisse/Unterordner werden zurückgeliefert. Falls keine Unterordner existieren wird ein leerer String zurückgeliefert.

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

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login ...
  subFolders = Elo.getSubFolders("Testdateien¶MSG¶Foobar")
 

Parameters:

archivePath - Archivpfad ohne Archivname, getrennt durch ClientConstants.ELO_SEPARATOR

Returns:

Die Namen der Unterverzeichnisse zu dem angegebenen Archivpfad

createSubFolder

VariantBool createSubFolder(BStr archivePath, BStr folderName)

Erstellt einen neuen Unterordner unterhalb des angegebenen Archivpfades. Der Archivpfad verweist auf das Parent Objekt. Archivpfade sind leider nicht eindeutig, da mehrere Unterordner eines Ordners den gleichen Namen haben können. In diesem Fall wird irgend ein Objekt ausgewählt.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Ein gültiger Archivpfad archivePath wird angegeben. Der Name des Unterordners folderName ist nicht leer.

Nachbedingung: Der angegebene Unterordner wurde unterhalb des angegebenen Archivpfads eingefügt. Die Anzeige wurde aktualisiert.

Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login ...
  success1 = Elo.createSubFolder("Testdateien¶MSG¶Foobar","FolderName")
  success2 = Elo.createSubFolder("","FolderName")
 

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

VariantBool makeLink(Int32 sourceObjectId, Int32 destinationObjectId)

Seiteneffekte: Verlinkt das Quellobjekt (Source) mit dem Zielobjekt (Destination).

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Das Quellobjekt mit der angegebenen sourceObjectId existiert. Das Zielobjekt mit der angegebenen destinationObjectId existiert.

Nachbedingung: Das Quellobjekt hält einen Link auf das Zielobjekt.

Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login ...
  success = Elo.makeLink(245,23)
 

Parameters:

sourceObjectId - Objekt Id des Quellobjekts

destinationObjectId - Objekt Id des Zielobjekts

Returns:

VariantBool.TRUE falls das Verlinken erfolgreich war

getObjectMaskId

Int32 getObjectMaskId(Int32 objectId)

Liefert die Masken Id des Archivobjekts mit der angegebenen Objekt Id

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Das Archivobjekt mit der angegebenen Objekt Id existiert im aktuell geöffneten Archiv.

Nachbedingung: Die Masken Id des Archivobjekts mit der angegebenen Objekt Id wird zurückgeliefert

Fehlerbehandlung: Im Fehlerfall wird -1 zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login ...
  maskId = Elo.getObjectMaskId(23)
 

Parameters:

objectId - Objekt Id eines Archivobjekts

Returns:

Masken Id des Archivobjekts

createReference

VariantBool createReference(Int32 objectId, Int32 newParentId)

Erzeugt eine Referenz für ein Archivobjekt in einem Archivordner.

Vorbedingung: Ein Benutzer hat sich über die login()- Methode angemeldet. Das Archivobjekt mit Objekt Id objectId existiert im aktuell geöffneten Archiv. Das Archivobjekt mit der Objekt Id newParentId ist ein Archivordner im aktuell geöffneten Archiv.

Nachbedingung: Eine Referenz auf das angegebene Archivobjekt wurde im angegebenen Archivordner angelegt.

Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.

Beispiel mit Visual Basic:

  set Elo = CreateObject("elo.enterprise")
  Elo.login ...
  success = Elo.createReference(123,456)
 

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