check_permission()
Prüft, ob der aktuelle Benutzer die angeforderten Berechtigungen auf einem Objekt
besitzt. Es geht genau ein DMS.CheckPermission hinaus, das alle angeforderten
Berechtigungen in seiner Access-Zeichenkette trägt.
Um zu prüfen, ob ein Objekt an einem Ort eingefügt werden darf, dient check_insert_permission().
1. Signatur
-
Sync
-
Async
ecm.dms.check_permission(
model: _ECMModelBase | int | str,
object_type_id: int | str | None = None,
*,
read: bool = False,
write: bool = False,
execute: bool = False,
delete: bool = False,
update: bool = False,
folder_id: int | str | ECMFolderModel | None = None,
register_id: int | str | ECMRegisterModel | None = None,
register_type: int | str | None = None,
) -> bool
await ecm.dms.check_permission(
model: _ECMModelBase | int | str,
object_type_id: int | str | None = None,
*,
read: bool = False,
write: bool = False,
execute: bool = False,
delete: bool = False,
update: bool = False,
folder_id: int | str | ECMFolderModel | None = None,
register_id: int | str | ECMRegisterModel | None = None,
register_type: int | str | None = None,
) -> bool
2. Parameter
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
|
|
— |
Entweder eine ECM-Modell-Instanz (deren |
|
|
|
Die numerische Objekttyp-ID. Wenn |
|
|
|
Prüft die Berechtigung zum Lesen von Indexdaten ( |
|
|
|
Prüft die Berechtigung zum Schreiben von Indexdaten ( |
|
|
|
Prüft die Berechtigung zum Öffnen/Ausführen ( |
|
|
|
Prüft die Löschberechtigung ( |
|
|
|
Prüft die Berechtigung zum Aktualisieren des Objekts ( |
|
|
|
ID des Ordners oder eine |
|
|
|
ID des übergeordneten Registers oder eine |
|
|
|
Typ des übergeordneten Registers. |
Mindestens eines der Flags read, write, execute, delete oder update muss True sein.
|
3. Zugriffsflags
| Flag | Parameter | Beschreibung |
|---|---|---|
|
|
Indexdaten des Objekts lesen. |
|
|
Indexdaten des Objekts schreiben. |
|
|
Objekt öffnen oder ausführen. |
|
|
Objekt löschen. |
|
|
Objekt aktualisieren (Dateien ersetzen). |
Alle angeforderten Flags reisen in einem einzigen DMS.CheckPermission. Der
Stapeljob DMS.CheckPermissions wird nicht verwendet: er erwartet nummerierte
ObjectType<n>- / ObjectList<n>-Parameter und beantwortet eine Anfrage für ein
einzelnes Objekt mit Rückgabecode 0 und ganz ohne Ausgabe.
4. Wie der Server das Ergebnis meldet
DMS.CheckPermission antwortet mit Rückgabecode 0, unabhängig davon, ob die
Berechtigungen bestehen oder nicht. Das Ergebnis steht im Ausgabeparameter
Access: jede gewährte Berechtigung wird an ihrer Stelle wiederholt, jede
verweigerte durch - ersetzt.
Gesendetes Access |
Zurückgegebenes Access |
Bedeutung |
|---|---|---|
|
|
Alle fünf Berechtigungen gewährt. |
|
|
Nur Lesen und Aktualisieren gewährt. |
|
|
Keine Berechtigung gewährt. |
|
|
Löschen verweigert. |
Ein Rückgabecode ungleich 0 ist damit nicht der Kanal für eine
Verweigerung. Ein Serverfehler bleibt eine Exception und wird nie zu einem False
verkürzt.
|
Mit explizitem object_type_id beantwortet der Server eine unbekannte
Objekt-ID oder einen falschen Typ genauso wie eine Verweigerung: Rückgabecode 0 und
- an jeder Stelle, das Ergebnis ist also False (gemessen auf enaio 12.0). Nur die
automatische Typauflösung wirft bei unbekannter ID eine ECMNotFoundException. Wer ein
fehlendes Objekt von einer Verweigerung unterscheiden muss, lässt object_type_id weg.
|
5. Rückgabewert
True, wenn der Benutzer alle angeforderten Berechtigungen besitzt, andernfalls
False. Eine fehlende oder unplausible Access-Ausgabe gilt als verweigert, damit
ein unlesbares Ergebnis den Zugriff nie ausweitet.
6. Ausnahmen
| Ausnahme | Bedingung |
|---|---|
|
|
|
|
7. Beispiele
7.1. Leseberechtigung auf einem Dokument prüfen
-
Sync
-
Async
doc = ecm.dms.get(InvoiceDocument, 12345)
if ecm.dms.check_permission(doc, read=True):
print("Read access granted")
doc = await ecm.dms.get(InvoiceDocument, 12345)
if await ecm.dms.check_permission(doc, read=True):
print("Read access granted")
7.2. Mehrere Berechtigungen gleichzeitig prüfen
-
Sync
-
Async
if ecm.dms.check_permission(12345, read=True, write=True, delete=True):
print("Full access")
else:
print("Restricted access")
if await ecm.dms.check_permission(12345, read=True, write=True, delete=True):
print("Full access")
else:
print("Restricted access")
8. Siehe auch
-
check_insert_permission() — Darf hier ein Objekt eingefügt werden?
-
delete() — Objekt löschen
-
insert() — Neues Objekt anlegen