Alle Superschnittstellen:: AutoDeleteParameter, IDispatch, IUnknown

Alle bekannten Implementierungsklassen:: EloComServer

public interface IObjectProperties extends IDispatch

Überschrift: IObjectProperties

Beschreibung: Diese Klasse ermöglicht die Änderung/Bearbeitung von Archivobjekten

Feldübersicht

Felder

Modifizierer und Typ

Feld

Beschreibung

static final String

INTERFACE_IDENTIFIER

IID für ComfyJ
Methodenübersicht

Modifizierer und Typ

Methode

Beschreibung

VariantBool

commitObject()

Beendet die Bearbeitung des aktuellen Archivobjekts und speichert die Änderungen auf den Indexserver.

BStr

getIndexField(Int32 objectId, Int32 fieldId)

Liefert den Wert des Indexfelds mit der angegebenen fieldId für das Archivobjekt mit der angegebenen objectId:

BStr

getObjAclEx(Int32 objectId)

Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen.

VariantBool

prepareObject(Int32 objectId)

Wenn ein Archivobjekt (Dokument oder Ordner) bearbeitet werden soll, muss es zunächst mit prepareObject(Int32) identifiziert werden.

VariantBool

setDescription(BStr description)

Setzt den Memo Text für das aktive Archivobjekt.

VariantBool

setIndexField(Int32 fieldId, BStr fieldValue)

Setzt das Indexfeld mit der angegebnen Id für das aktuelle Archivobjekt.

VariantBool

setMaskId(Int32 maskId)

Setzt die Verschlagwortungs-Maske des aktiven Archivobjekts auf die Maske mit der angegebenen Masken Id.

VariantBool

setName(BStr name)

Setzt den Namen bzw. die Kurzbezeichnung des aktuellen Archivobjekts.

void

setObjAcl(BStr aclString)

Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen.

VariantBool

setObjAcl2(BStr aclString)

Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen.

Von Schnittstelle geerbte Methoden AutoDeleteParameter
isAutoDelete, setAutoDelete

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

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

Felddetails
- INTERFACE_IDENTIFIER
  
  static final String INTERFACE_IDENTIFIER
  
  IID für ComfyJ
  Siehe auch:
  
  Konstantenfeldwerte
Methodendetails
- prepareObject
  
  VariantBool prepareObject(Int32 objectId)
  Wenn ein Archivobjekt (Dokument oder Ordner) bearbeitet werden soll, muss es zunächst mit prepareObject(Int32) identifiziert werden. Dann können die verschiedenen Set-Methoden aufgerufen werden. Zum endgültigen Speichern muss commitObject() aufgerufen werden.
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Ein Archivobjekt mit der angegebenen Objekt Id existiert im Archiv.
  
  Nachbedingung: Das Archivobjekt mit der angegebenen Objekt-Id kann jetzt bearbeitet werden.
  
  Fehlerbehandlung: Falls die ObjektId nicht existiert oder bei anderen Fehlern wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.set... Elo.set... Elo.set... Elo.set... Elo.commitObject
  Parameter:
  
  objectId - Objekt Id des Archivobjekts
  
  Gibt zurück:
  
  VariantBool.TRUE, falls die Objekt Id im Archiv vorhanden ist und kein Fehler aufgetreten ist
- setDescription
  
  VariantBool setDescription(BStr description)
  Setzt den Memo Text für das aktive Archivobjekt.
  
  Vorbedingung: Die Methode prepareObject(Int32) wurde aufgerufen und liefert VariantBool.TRUE.
  
  Nachbedingung: Der Memo Text für das Archivobjekt wurde gesetzt. Zum endgültigen Speichern muss commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.setDescription "Beschreibungstext" Elo.commitObject
  Parameter:
  
  description - Memo Text
  
  Gibt zurück:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- setMaskId
  
  VariantBool setMaskId(Int32 maskId)
  Setzt die Verschlagwortungs-Maske des aktiven Archivobjekts auf die Maske mit der angegebenen Masken Id.
  
  Vorbedingung: Die Methode prepareObject(Int32) wurde aufgerufen und liefert VariantBool.TRUE.
  
  Nachbedingung: Die Maske des aktiven Archivobjekts wurde geändert. Zum endgültigen Speichern muss commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.setMaskId(20) Elo.commitObject
  Parameter:
  
  maskId - Masken Id
  
  Gibt zurück:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- setIndexField
  
  VariantBool setIndexField(Int32 fieldId, BStr fieldValue)
  Setzt das Indexfeld mit der angegebnen Id für das aktuelle Archivobjekt.
  
  Vorbedingung: Die Methode 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 commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.setIndexField 7,"Bar" Elo.commitObject
  Parameter:
  
  fieldId - Id des Indexfelds
  
  fieldValue - Neuer Wert des Indexfelds
  
  Gibt zurück:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- setName
  
  VariantBool setName(BStr name)
  Setzt den Namen bzw. die Kurzbezeichnung des aktuellen Archivobjekts.
  
  Vorbedingung: Die Methode 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 commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.setName "Foo" Elo.commitObject
  Parameter:
  
  name - Name bzw. Kurzbezeichnung für das Archivobjekt
  
  Gibt zurück:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- commitObject
  
  VariantBool commitObject()
  Beendet die Bearbeitung des aktuellen Archivobjekts und speichert die Änderungen auf den Indexserver.
  
  Vorbedingung: Die Methode 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 prepareObject(Int32) aufgerufen werden.
  
  Fehlerbehandlung: Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(12345) Elo.set... Elo.set... Elo.set... Elo.set... Elo.commitObject
  Gibt zurück:
  
  VariantBool.TRUE, falls kein Fehler aufgetreten ist
- getIndexField
  
  BStr getIndexField(Int32 objectId, 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. Eine Workspace Ansicht ist aktiv. Ein Archivobjekt mit der angegebenen Objekt Id existiert im Archiv. Das Archivobjekt hat eine Dokumentenmaske, welche ein Feld mit der angegebenen fieldId enthält
  
  Nachbedingung: Der Wert des Indexfelds wird zurückgeliefert.
  
  Fehlerbehandlung: Falls einer der Punkte der Vorbedingung nicht erfüllt ist wird ein leerer String zurückgeliefert. Falls ein anderer Fehler auftritt wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... fieldValue = Elo.getIndexField(2,3)
  Parameter:
  
  objectId - Objekt Id eines existierenden Archivobjekts
  
  fieldId - Field Id eines Indexfelds in der Dokumentenmaske des Archivobjekts
  
  Gibt zurück:
  
  Wert des Indexfelds in der Dokumentenmaske des Archivobjekts
- getObjAclEx
  
  BStr getObjAclEx(Int32 objectId)
  Über das Property ObjAcl können Sie die AccessControlList des aktuellen Eintrags abfragen oder setzen. Dabei ist für die Abfrage mindestens ein lesender Zugriff auf das Objekt notwendig, für das Setzen ein schreibender.
  
  Wenn Sie das Property abfragen erhalten Sie einen Text der Form <Eintrag>,<Eintrag>,...<Eintrag>
  Unter Eintrag steht erst mal ein Kennzeichen um was für ein Zugriffsrecht es sich handelt und anschließend die Nummer des betroffenen Schlüssels, Anwenders oder Gruppe. Das Kennzeichen ist immer mindestens einem Zeichen, folgende Möglichkeiten existieren:
  
  K Es handelt sich um einen Schlüsseleintrag
  R Ein Anwender- oder Gruppeneintrag mit Leserecht
  W Ein Anwender- oder Gruppeneintrag mit Schreibrecht
  D Ein Anwender- oder Gruppeneintrag mit Löschrecht
  E Ein Anwender- oder Gruppeneintrag mit Dateibearbeitungsrecht
  
  Die Kennzeichen R, W, D, E können miteinander kombiniert werden, K muss immer alleine mit einer Schlüsselnummer stehen.
  
  Beispiel: Sie erhalten einen Eintrag „K2,R3,RW4,RWDE5“. Dann ist der Schlüssel 2 gesetzt und der Anwender oder die Gruppe 3 hat Leserecht, 4 hat Lese- und Schreibrecht und 5 darf lesen, schreiben, das Dokument löschen und die Dokumentendatei bearbeiten..
  
  Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Das Archivobjekt mit der angegebenen Objekt Id existiert im Archiv.
  
  Nachbedingung: Die codierte Access Control List ACL wird zurückgeliefert.
  
  Fehlerbehandlung: Falls einer der Punkte der Vorbedingung nicht erfüllt ist wird ein leerer String zurückgeliefert. Falls ein anderer Fehler auftritt wird ein leerer String zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... acl = Elo.getObjAcl(487549)
  Parameter:
  
  objectId - Objekt Id eines Archivobjekts
  
  Gibt zurück:
  
  Codierte Access Control List ACL
- setObjAcl
  
  void setObjAcl(BStr aclString)
  Ü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 prepareObject(Int32) wurde aufgerufen und liefert VariantBool.TRUE.
  
  Nachbedingung: Die Access Control List des aktiven Archivobjekts wurde geändert. Zum endgültigen Speichern muss commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Falls der angegebene ACL String nicht wohlgeformt ist, d.h. die Syntax von ACL Strings verletzt, wird VariantBool.FALSE zurückgeliefert. Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(487549) Elo.setObjAcl("K2,R3,RW4,RWDE5") Elo.commitObject()
  Parameter:
  
  aclString - Wohlgeformter ACL String, siehe oben
- setObjAcl2
  
  VariantBool setObjAcl2(BStr aclString)
  Ü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 prepareObject(Int32) wurde aufgerufen und liefert VariantBool.TRUE.
  
  Nachbedingung: Die Access Control List des aktiven Archivobjekts wurde geändert. Zum endgültigen Speichern muss commitObject() aufgerufen werden.
  
  Fehlerbehandlung: Falls der angegebene ACL String nicht wohlgeformt ist, d.h. die Syntax von ACL Strings verletzt, wird VariantBool.FALSE zurückgeliefert. Im Fehlerfall wird VariantBool.FALSE zurückgeliefert.
  
  Beispiel mit Visual Basic:
  
  set Elo = CreateObject("elo.enterprise") Elo.login ... Elo.prepareObject(487549) success = Elo.setObjAcl2("K2,R3,RW4,RWDE5") Elo.commitObject()
  Parameter:
  
  aclString - Wohlgeformter ACL String, siehe oben
  
  Gibt zurück:
  
  VariantBool.TRUE bei Erfolg

Schnittstelle IObjectProperties

Feldübersicht

Methodenübersicht

Von Schnittstelle geerbte Methoden AutoDeleteParameter

Von Schnittstelle geerbte Methoden IDispatch

Von Schnittstelle geerbte Methoden IUnknown

Felddetails

INTERFACE_IDENTIFIER

Methodendetails

prepareObject

setDescription

setMaskId

setIndexField

setName

commitObject

getIndexField

getObjAclEx

setObjAcl

setObjAcl2