Fügt einen Absatz zum Bericht hinzu.

   using Isom.Base.* 
   using Isom.Reporting.*; 
   ... 
      Report        report  = Report.CreateReport("FinalReport"); 
      ReportSection section = report.CreateReportSection( "Actions" ); 
      report.AddSection( section ); 

      // section.Set...() 

Parameter:

sect

hinzuzufügender Absatz.

Rückgabe:

'true' im Erfolgsfall (derzeit immer).

Erzeugt eine identische Kopie des Objekts.

Rückgabe:

Das geklonte Objekt.

Erzeugt eine neue, leere Objekt-Instanz mit der vorgegebenen ID.

Zu beachten:

Für ein zusammenhängendes Beispiel siehe Report.

   using Isom.Base.* 
   using Isom.Reporting.*; 
   ... 
      // Neuen, leeren AB erzeugen 
      Report report = Report.CreateReport("FinalReport"); 

      // report. ... 

Rückgabe:

Objektinstanz oder 'Void'.

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben, falls die ID Void oder die ID leer ist.

Es wird das Void-Objekt zurückgegeben, falls für die ID bereits ein Bericht existiert.

Erzeugt eine neue, leere Objektinstanz eines Bericht-Absatzes.

Achtung:

Die Funktion Report.CreateReportSection() ist nur zu verwenden, wenn das zugehörige Template auf der obersten Ebene des Baums definiert ist, d.h. wenn ein First-Level-Zweig erzeugt werden soll. Für tieferliegende Ebenen ist stattdessen ReportSection.CreateReportSection() zu verwenden.

Zu beachten:

Für ein zusammenhängendes Beispiel siehe Report.

   using Isom.Base.*; 
   using Isom.Reporting.*; 
   ... 
      Report        report  = Report.CreateReport("FinalReport"); 
      ReportSection section = report.CreateReportSection( "Messages" ); 
      report.AddSection( section ); 

      // section.Set...() 

Rückgabe:

Objektinstanz.

Ermittelt die Dokumentstruktur als ASCII (für das Debugging / Tracing).

   using Isom.Base.* 
   using Isom.Reporting.*; 
   ... 
      Report report  = Report.CreateReport("FinalReport"); 
      // ... fill 'report' 
      System.Stdout( report.GetAsciiArt() ); 

Rückgabe:

Dokumentstruktur als ASCII (mit Zeilenumbrüchen).

Ruft eine Liste der IDs aller bereits erzeugten Report-Objekte ab

   StringList existingReports = Report.GetExistingReports(); 

Rückgabe:

Eine Liste der Bezeichnungen aller bereits erzeugter Report-Objekte

Ermittelt die ID-Pfade aller Sektionen / Elemente, die noch nicht hinreichend befüllt sind, um ihrem Template zu genügen.

Rückgabe:

ID-Pfade mit fehlenden informationen.

Greift auf eine Objekt-Instanz über die vorgegebene ID zu.

Zu beachten:

Das Objekt wird dabei nicht bedarfs-erzeugt.

Für ein zusammenhängendes Beispiel siehe Report.

   using Isom.Base.* 
   using Isom.Reporting.*; 
   ... 
      Report report  = Report.GetReport("FinalReport"); 
      if( report.IsVoid() ) 
      { 
          report = Report.CreateReport("FinalReport"); 
      } 

      // report. ... 

Rückgabe:

Objektinstanz oder 'Void'.

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben, falls die ID Void oder leer ist.

Es wird das Void-Objekt zurückgegeben, falls für die ID bereits ein Bericht existier.

Greift auf den über Id benannten, existierenden Berichtsabschnitt zu.

Zu beachten:

Für ein zusammenhängendes Beispiel siehe Report.

Siehe auch:

Isom.Reporting.Report.SetTemplate() für das Zurücksetzen des Objekts auf Leerzustand mit Templates.

   using Isom.Base.*; 
   using Isom.Reporting.*; 
   ... 
      Report        report  = Report.CreateReport("FinalReport"); 
      ReportSection section = report.GetReportSection( "Messages" ); 

      // section.Set...() 

Rückgabe:

Objektinstanz oder 'Void'.

Listen-Zugriff auf die Objekt-Absätze.

   using Isom.Base.*; 
   using Isom.Reporting.*; 
   ... 
      Report report = ...; 
      ReportSectionList sections = report.GetReportSectionList(); 
      sections.Reset(); 
      while( sections.HasNext() ) 
      { 
          ReportSection section = sections.Next(); 
          // ... 
      } 

Rückgabe:

Liste (ggf. leer).

Prüft, ob für den Bericht bereits Report.Publish() für dieses Objekt mindestens einmal aufgerufen wurde.

Rückgabe:

'true' wenn bereits publiziert, 'false' sonst.

Bestimmt, ob es sich um das Void-Objekt handelt.

Rückgabe:

'true', falls dies das Void-Objekt ist, 'false' sonst.

Registriert die Report-Instanz unter dem angegebenen technischen Namen und macht den Report damit offiziell/anzeigbar.

Zu beachten:

Mehrfachregistrierung des gleichen Reports unter verschiendenen Namen ist nicht möglich.

Es wird eine Warnung 'Der publizierte Bericht '...' enthält unvollständige Elemente' geloggt, wenn das Report-Objekt nicht vollständig befüllt ist.

   // @file Consts.is 
    deftext INTERNAL NAMECONST_REPORT_COMPLETEPLAN "CompletePlan" 
    deftext INTERNAL NAMECONST_REPORT_FINALPLAN    "FinalPlan" 

   // @file Vendor.is 
   using Isom.Base.* 
   using Isom.Reporting.*; 
   ... 
      Report report  = Report.CreateReport("FinalReport"); 
      // ... fill 'report' 
      report.Publish( Consts.NAMECONST_REPORT_COMPLETEPLAN ); 
      report.Publish( Consts.NAMECONST_REPORT_FINALPLAN ); 

Rückgabe:

'true' im Erfolgsfall.

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben, falls 'Void' als ID übergeben wurde.

Es wird das Void-Objekt zurückgegeben, falls ein Leerstring als ID übergeben wurde.

Entfernt einen Absatz aus dem Bericht.

   using Isom.Base.* 
   using Isom.Reporting.*; 
   ... 
      Report        report  = Report.CreateReport("FinalReport"); 
      ReportSection section = report.GetSubsection( "Actions" ); 
      report.RemoveSection( section ); 

Parameter:

sect

zu entfernender Absatz.

Rückgabe:

'true' im Erfolgsfall (derzeit immer).

Setzt die ID/den Namen des Templates, der zur Formatierung des Berichts dient und lädt das zugehörige Template.

Achtung:

Da die Template-ID die Schablone bestimmt, muss der Aufruf von Report.SetTemplate(...) vor allen Zuweisungen erfolgen.

Ein späterer Neuaufruf von Report.SetTemplate(...) mit abweichender templateID löscht vorherige Zuweisungen und Templates.

Zu beachten:

Welche IDs zulässig sind, obliegt einem Kontrakt zwischen ISOM/L-Programmen und Anzeigeapplikation ("Client").

Es sollten nur IDs verwendet werden, für die ein Template in den Servicedaten existiert.

   // @file Consts.is 
    deftext INTERNAL STYLECONST_REPORT_COMPLETEPLAN_PARALLEL "COMPLETEPLAN_PARALLEL" 

   // @file Vendor.is 
   using Isom.Base.* 
   using Isom.Reporting.*; 
   ... 
      Report report  = Report.CreateReport("FinalReport"); 
      report.SetTemplate( Consts.STYLECONST_REPORT_COMPLETEPLAN_PARALLEL ); 

Parameter:

templateID

technische ID (beliebige Zeichenkette).

Rückgabe:

eindeutiger ID/den Namen des Templates (technisch; nicht-übersetzbar).

Setzt die die Überschrift für den Bericht.

Die Übergabe von 'Void' setzt die Überschrift zurück.

   // @file Texts.is 
    deftext TITLE TITLE_REPORT_COMPLETEPLAN_PARALLEL "Aktionsplan (Parallel-Darstellung)" 

   // @file Vendor.is 
   using Isom.Base.* 
   using Isom.Reporting.*; 
   ... 
      Report report  = Report.CreateReport("FinalReport"); 
      report.SetTitle( Texts.TITLE_REPORT_COMPLETEPLAN_PARALLEL ); 

Parameter:

title

Absatz-[Unter]Überschrift (übersetzbar).

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben, falls dem Report noch kein Template zugewiesen wurde (vgl. Report.SetTemplate(...)).

Erzeugt ein ungültiges Objekt.

Die Funktion kann in Fehlerfällen verwendet werden, um z.B. einen ungültigen Funktionsrückgabewert zu erzeugen.

Rückgabe:

Ungültiges Objekt.