Isom.Sys.Protocol

 ISOM/L-Bibliothek für Serviceautoren: <br />Isom.Sys.Protocol

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Sys.Protocol

Beschreibung

Mit Hilfe dieses Fachobjekts kann ein XML-basiertes Protokoll der Therapiesitzung erzeugt werden. Die Struktur des XML-Dokuments kann durch den Serviceautor frei definiert werden. Es werden keinerlei Annahmen getroffen.



Funktionen

Isom.Sys.Protocol.AddAttribute

Fügt dem Dokumentknoten des Sitzungsprotokolls ein Attribut hinzu.

Isom.Base.Boolean Isom.Sys.Protocol.AddAttribute  ( Isom.Base.String  name,
Isom.Base.String  text  )

Fügt dem Dokumentknoten des Sitzungsprotokolls ein Attribut hinzu.

 Isom.Sys.Protocol.AddAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance"); 
Parameter:
name  Der Name des Attributs.
text  Der Text des Attributs.
Rückgabe:
'true', falls das Attribut hinzugefügt wurde, 'false' sonst.
Isom.Sys.Protocol.AddEntry

Fügt dem Sitzungsprotokoll ein Ereignis hinzu.

Isom.Base.Boolean Isom.Sys.Protocol.AddEntry  ( Isom.Base.Data  entry  ) 

Fügt dem Sitzungsprotokoll ein Ereignis hinzu.

Parameter:
entry  Das Ereignis.
Rückgabe:
'true' bei erfolgreicher Ausführung, 'false' sonst.
Isom.Sys.Protocol.AddToHeader

Fügt dem Kopf des Sitzungsprotokolls einen Eintrag hinzu.

Isom.Base.Boolean Isom.Sys.Protocol.AddToHeader  ( Isom.Base.Data  entry  ) 

Fügt dem Kopf des Sitzungsprotokolls einen Eintrag hinzu.

Parameter:
entry  Der Eintrag.
Rückgabe:
'true' bei erfolgreicher Ausführung, 'false' sonst.
Isom.Sys.Protocol.CreateHeader

Erzeugt den Kopfeintrag des Fachobjekts Protocol.

Isom.Base.Boolean Isom.Sys.Protocol.CreateHeader  ( Isom.Base.String  name  ) 

Erzeugt den Kopfeintrag des Fachobjekts Protocol.

Zu beachten:
Muss einmal aufgerufen werden, bevor in das Sitzungsprotokoll geschrieben werden kann.
Parameter:
name  Der Name des Knotens für den Kopfeintrag.
Rückgabe:
'true', falls der Knoten noch nicht existiert hat, 'false' sonst.
Isom.Sys.Protocol.CreateProtocol

Erzeugt die Instanz des Fachobjekts Protocol.

Isom.Base.Boolean Isom.Sys.Protocol.CreateProtocol  ( Isom.Base.String  name  ) 

Erzeugt die Instanz des Fachobjekts Protocol.

Zu beachten:
Muss einmal aufgerufen werden, bevor in das Sitzungsprotokoll geschrieben werden kann.
Parameter:
name  Der Name des Dokumentknotens (Wurzelknotens).
Rückgabe:
'true', falls der Knoten noch nicht existiert hat, 'false' sonst.
Isom.Sys.Protocol.GetArchiveName

Ermittelt den Namen eines Archivs, das Protokolldateien der laufenden Sitzung enthält.

Isom.Base.String Isom.Sys.Protocol.GetArchiveName  ( Isom.Base.String  archiveId  ) 

Ermittelt den Namen eines Archivs, das Protokolldateien der laufenden Sitzung enthält.

In den Protokollierungsrichtlinien kann eine beliebige Anzahl von Archiven definiert werden. Jedem Archiv ist eine eindeutige ID zugeordnet über die es referenziert werden kann.

Parameter:
archiveID  ID des Archivs dessen Name ermittelt werden soll.
Rückgabe:
Der Name des Archivs.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls kein Archiv mit der angegebenen ID definiert ist.
Isom.Sys.Protocol.GetFileName

Ermittelt den Namen der Datei, in der das Sitzungsprotokoll gespeichert wird.

Isom.Base.String Isom.Sys.Protocol.GetFileName  (  ) 

Ermittelt den Namen der Datei, in der das Sitzungsprotokoll gespeichert wird.

Bemerkungen:
Der Name muss vorher mit Hilfe der Fachfunktion 'SetFileName' gesetzt worden sein.
Rückgabe:
Der Dateiname.
Siehe auch:
Isom.Sys.Protocol.SetFileName()
Isom.Sys.Protocol.GetHeader

Gibt den Kopfeintrag des Sitzungsprotokolls zurück.

Isom.Base.Data Isom.Sys.Protocol.GetHeader  (  ) 

Gibt den Kopfeintrag des Sitzungsprotokolls zurück.

Diese Fachfunktion gibt eine Kopie des Kopfeintrags zurück. Änderungen an der Kopie haben keine Auswirkung auf das Sitzungsprotokoll. Um den Kopfeintrag zu erweitern, muss die Fachfunktion 'AddToHeader' verwendet werden.

Rückgabe:
Der Kopfeintrag.
Siehe auch:
Isom.Sys.Protocol.AddToHeader()
Isom.Sys.Protocol.SetFileName

Setzt den Namen (und das Verzeichnis) für die Datei, in der das Sitzungsprotokoll gespeichert wird.

Isom.Base.Boolean Isom.Sys.Protocol.SetFileName  ( Isom.Base.String  fileName  ) 

Setzt den Namen (und das Verzeichnis) für die Datei, in der das Sitzungsprotokoll gespeichert wird.

 Isom.Base.String dateTime = Isom.Base.Date.Now().ToUniversalTimeFormatted("yyyyMMdd_HHmmss"); 

 Isom.Base.String name = "XXXXXXX_DEALER_"; 
 name.Append(dateTime); 
 name.Append(".prot"); 

 Isom.Base.Boolean success = Isom.Sys.Protocol.SetFileName(name); 
Parameter:
fileName  Der Name der Protokolldatei.
Rückgabe:
'true' bei erfolgreicher Ausführung, 'false' sonst.
Siehe auch:
Isom.Sys.Protocol.GetFileName()

Version 9.10.1.0 vom 25 November 2013