Namensraum Isom.Reporting.ReportSection
Beschreibung
Ein Berichts-Absatz entspricht einem ISOM-Datenhalter für ein Kapitel innerhalb eines Berichts (s. Isom.Reporting.Report). Er kann eine Überschrift haben und ihm kann eine Formatierungsvorschrift zugewiesen werden. Die Formatierung selbst ist jedoch nicht Gegenstand des ISOM-Berichtsobjekts. Für einen Berichts-Absatz kann vom Client ein Template zugewiesen sein, welches festlegt welche Elementetypen mit welcher ID oder mit welcher Multiziplität dem Berichtsabschnittzugewiesen werden können.
-
Zu beachten:
- Für ein zusammenhängendes Beispiel siehe Report.
Funktionen
|
Isom.Reporting.ReportSection.AddSubsection |
Fügt einen Absatz zum Bericht hinzu.
Fügt einen Absatz zum Bericht hinzu.
using Isom.Base.*
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
ReportSection sub = section.GetSubsection( "Messages" );
section.AddSubSection( sub );
-
Parameter:
-
|
sect
|
hinzuzufügender Absatz. |
-
Rückgabe:
- 'true' im Erfolgsfall (derzeit immer).
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls 'Void' als Parameter übergeben wurde.
- Es wird das Void-Objekt zurückgegeben, falls dem Report noch kein Template zugewiesen wurde (vgl\.
Report.SetTemplate(...)
).
- Es wird das Void-Objekt zurückgegeben, falls durch das Hinzufügen eine Rekursion ausgelöst würde.
- Es wird das Void-Objekt zurückgegeben, falls für die ID des übergebenen Absatzes kein Template gefunden wurde.
- Es wird das Void-Objekt zurückgegeben, durch das Hinzufügen der Zähler 'MaxRepeat" des Templates überschritten würde.
|
Isom.Reporting.ReportSection.Clone |
Erzeugt eine identische Kopie des Objekts.
Erzeugt eine identische Kopie des Objekts.
-
Rückgabe:
- Das geklonte Objekt.
|
Isom.Reporting.ReportSection.CreateSubsection |
Erzeugt eine neue, leere Objektinstanz eines Bericht-Absatzes.
Erzeugt eine neue, leere Objektinstanz eines Bericht-Absatzes.
-
Achtung:
- Die Funktion Report.CreateSubsection() 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\. Nur für tieferliegende Ebenen ist ReportSection.CreateSubsection() 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.GetSubsection( "Actions" );
ReportSection sub = section.CreateSubsection( "Messages" );
section.AddSubSection( sub );
-
Rückgabe:
- Objektinstanz.
|
Isom.Reporting.ReportSection.GetDate |
Ermittelt ein Kontextelement vom Typ "Date"/Zeitpunkt innerhalb des Bericht-Absatzes.
Ermittelt ein Kontextelement vom Typ "Date"/Zeitpunkt innerhalb des Bericht-Absatzes.
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID). |
-
Rückgabe:
- Kontextelement oder 'Void'.
|
Isom.Reporting.ReportSection.GetDisplayProp |
Ermittelt einen [potentiell übersetzbaren] Property-Wert.
Ermittelt einen [potentiell übersetzbaren] Property-Wert.
-
Zu beachten:
- Für ein zusammenhängendes Beispiel siehe Report.
deftext INTERNAL REPORTPROPNAME_FORMATTINGHINT "FormattingHint"
deftext INTERNAL REPORTPROPVALUE_BLUE "Color:Blue"
using Isom.Base.*;
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
String propName = Consts.REPORTPROPNAME_FORMATTINGHINT;
if( section.GetDisplayProp( propName ).IsVoid() )
{
String propVal = Consts.REPORTPROPVALUE_BLUE;
section.SetDisplayProp( propName, propVal );
}
-
Parameter:
-
|
propName
|
Name der Eigenschaft (Groß-Kleinschreibung signifikant). |
-
Rückgabe:
- Property-Wert.
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls der Wert ungesetzt ist.
|
Isom.Reporting.ReportSection.GetDisplayPropNames |
Liefert die Namen aller Anzeige-Eigenschaften des Bericht-Absatzes.
Liefert die Namen aller Anzeige-Eigenschaften des Bericht-Absatzes.
Es werden die Eigenschaftsnamen für die Anzeige-Eigenschaften (siehe Isom.Reporting.ReportSection.GetDisplayProp()) zurückgeliefert.
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
StringList displayPropertyNames = section.GetDisplayPropNames();
displayPropertyNames.Reset();
while(displayPropertyNames.HasNext())
{
}
-
Rückgabe:
- Isom.Base.StringList
Liste der Namen aller Anzeige-Eigenschaften des Bericht-Absatzes.
-
Siehe auch:
-
Isom.Reporting.ReportSection.GetDisplayProp()
-
Datum:
- letzte Änderung am 09.09.2010
|
Isom.Reporting.ReportSection.GetEcu |
Ermittelt ein Kontextelement vom Typ "Ecu"/Steuergerät innerhalb des Bericht-Absatzes.
Ermittelt ein Kontextelement vom Typ "Ecu"/Steuergerät innerhalb des Bericht-Absatzes.
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID). |
-
Rückgabe:
- Kontextelement oder 'Void'.
|
Isom.Reporting.ReportSection.GetElementKeysByType |
Ermittelt die technischen ID's aller im Abschnitt unmittelbar enthaltenen Elemente eines vorgegebenen Typs.
Ermittelt die technischen ID's aller im Abschnitt unmittelbar enthaltenen Elemente eines vorgegebenen Typs.
using Isom.Base.*;
using Isom.Reporting.*;
...
ReportSection section = ...;
String typeSpec = "[Isom.DataModel.IsomStringDO]";
StringList idList = section.GetElementKeysByType( typeSpec );
idList.Reset();
while( idList.HasNext() )
{
String idStr = idList.Next();
String valueStr = section.GetText(idStr);
...
}
-
Parameter:
-
|
typeSpec
|
Typ-Spezifikation entsprechend den DataObject- Attributen in der Berichtsvorlage. Die eckigen Klammern können wahlweise weggelassen werden. |
-
Rückgabe:
- Liste der technischen ID's der Elemente des Abschnitts.
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls die übergebene Typspezifikation Void ist.
-
Zu beachten:
- Es werden nur die Schlüssel derjenigen Elemente geliefert, die sich unmittelbar in dem aufrufenden Berichtsabschnitt befinden und die eine ID haben. Unterabschnitte werden nicht berücksichtigt.
|
Isom.Reporting.ReportSection.GetError |
Ermittelt ein Kontextelement vom Typ "Error" innerhalb des Bericht-Absatzes.
Ermittelt ein Kontextelement vom Typ "Error" innerhalb des Bericht-Absatzes.
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID). |
-
Rückgabe:
- Kontextelement oder 'Void'.
|
Isom.Reporting.ReportSection.GetKey |
Ermittelt die technische ID des Abschnitts.
Ermittelt die technische ID des Abschnitts.
using Isom.Base.*;
using Isom.Reporting.*;
...
ReportSection section = ...;
String id = section.GetKey();
-
Rückgabe:
- technische ID des Abschnitts.
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls der Wert ungesetzt ist.
|
Isom.Reporting.ReportSection.GetReportSectionList |
Greift auf alle Unterabschnitte des aktuellen Abschnitts zu.
Greift auf alle Unterabschnitte des aktuellen Abschnitts zu.
using Isom.Base.*
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSectionList list = section.GetReportSectionList();
while ( list.HasNext() )
DoSomething( list.Next() );
-
Rückgabe:
- Gefundene Unterabschnitte in Einfügereihenfolge.
|
Isom.Reporting.ReportSection.GetSubsection |
Greift auf einen benannten Unterabschnitt des aktuellen Abschnitts zu.
Greift auf einen benannten Unterabschnitt des aktuellen Abschnitts zu.
using Isom.Base.*
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
ReportSection sub = section.GetSubsection( "Messages" );
section.AddSubSection( sub );
-
Parameter:
-
|
id
|
des zu suchenden Unterabschnitts. |
-
Rückgabe:
- Gefundener Unterabschnitt oder 'Void'.
|
Isom.Reporting.ReportSection.GetText |
Ermittelt ein Darstellungselement vom Typ "Text" innerhalb des Bericht-Absatzes.
Ermittelt ein Darstellungselement vom Typ "Text" innerhalb des Bericht-Absatzes.
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID). |
-
Rückgabe:
- Kontextelement oder 'Void'.
|
Isom.Reporting.ReportSection.GetTherapyPlanAction |
Ermittelt ein Kontextelement vom Typ "TherapyPlanAction" innerhalb des Bericht-Absatzes.
Ermittelt ein Kontextelement vom Typ "TherapyPlanAction" innerhalb des Bericht-Absatzes.
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID). |
-
Rückgabe:
- Kontextelement oder 'Void'.
|
Isom.Reporting.ReportSection.GetUserProfileSetting |
Ermittelt ein Kontextelement vom Typ "UserProfileSetting"/Einstellung innerhalb des Bericht-Absatzes.
Ermittelt ein Kontextelement vom Typ "UserProfileSetting"/Einstellung innerhalb des Bericht-Absatzes.
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID). |
-
Rückgabe:
- Kontextelement oder 'Void'.
|
Isom.Reporting.ReportSection.IsVoid |
Bestimmt, ob es sich um das Void-Objekt handelt.
Bestimmt, ob es sich um das Void-Objekt handelt.
-
Rückgabe:
- 'true', falls dies das Void-Objekt ist, 'false' sonst.
|
Isom.Reporting.ReportSection.RemoveSubsection |
Entfernt einen Absatz aus dem Bericht.
Entfernt einen Absatz aus dem Bericht.
using Isom.Base.*
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
ReportSection sub = section.CreateSubsection( "Messages" );
section.RemoveSubsection( sub );
-
Parameter:
-
|
sect
|
zu entfernender Absatz. |
-
Rückgabe:
- 'true' im Erfolgsfall (derzeit immer).
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls 'Void' als Parameter übergeben wurde.
- Es wird das Void-Objekt zurückgegeben, falls der vorgegebene Abschnitt nicht im Aufrufobjekt enthalten ist.
- Es wird das Void-Objekt zurückgegeben, falls durch das Entfernen der Zähler 'MinRepeat' unterschritten würde.
|
Isom.Reporting.ReportSection.SetDate |
Setzt ein Kontextelement vom Typ "Date"/Zeitpunkt innerhalb des Bericht-Absatzes.
Setzt ein Kontextelement vom Typ "Date"/Zeitpunkt innerhalb des Bericht-Absatzes.
-
Zu beachten:
- Die Darstellung obliegt einem Kontrakt zwischen ISOM/L-Programmen und Anzeigeapplikation (Client).
using Isom.Base.*;
using Isom.Sys.Error;
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
section.SetDate( "StartTime", date );
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID) oder Leerstring ("") für "ID automatisch vergeben" bzw. "letztes Element des Typs". |
|
date
|
Datums-Objekt (Darstellung Client-abhängig). |
-
Rückgabe:
- 'true' im Erfolgsfall (derzeit immer).
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls dem Report noch kein Template zugewiesen wurde (vgl\.
Report.SetTemplate(...)
).
- Es wird das Void-Objekt zurückgegeben, falls eine ID vorgegeben wurde und kein entsprechendes Element im Abschnitt/Template existiert.
- Es wird das Void-Objekt zurückgegeben, falls ein Element/Template mit gleicher ID existiert, aber einen anderen Assoziationstyp hat (z\.B\. Client-Template oder vorher andere
Set...()
-Funktion benutzt).
|
Isom.Reporting.ReportSection.SetDisplayProp |
Setzt einen [potentiell übersetzbaren] Eigenschafts-Wert.
Setzt einen [potentiell übersetzbaren] Eigenschafts-Wert.
-
Zu beachten:
- Für ein zusammenhängendes Beispiel siehe Report.
deftext INTERNAL REPORTPROPNAME_FORMATTINGHINT "FormattingHint"
deftext INTERNAL REPORTPROPVALUE_BLUE "Color:Blue"
using Isom.Base.*;
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
String propName = Consts.REPORTPROPNAME_FORMATTINGHINT;
if( section.GetDisplayProp( propName ).IsVoid() )
{
String propVal = Consts.REPORTPROPVALUE_BLUE;
section.SetDisplayProp( propName, propVal );
}
-
Parameter:
-
|
propName
|
Name der Eigenschaft (Groß-Kleinschreibung signifikant). |
|
propValue
|
zu setzender Wert der Eigenschaft oder 'Void', um die Property zurückzusetzen. |
-
Rückgabe:
- 'true', falls der Property-Wert erfolgreich eingetragen bzw. entfernt wurde, 'false' sonst.
|
Isom.Reporting.ReportSection.SetEcu |
Setzt ein Kontextelement vom Typ "Ecu"/Steuergerät innerhalb des Bericht-Absatzes.
Setzt ein Kontextelement vom Typ "Ecu"/Steuergerät innerhalb des Bericht-Absatzes.
-
Zu beachten:
- Die Darstellung obliegt einem Kontrakt zwischen ISOM/L-Programmen und Anzeigeapplikation (Client).
using Isom.Base.*;
using Isom.Context.Ecu;
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
section.SetEcu( "MainGateway", ecu );
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID) oder Leerstring ("") für "ID automatisch vergeben" bzw. "letztes Element des Typs". |
|
ecu
|
Steuergeräte-Fachobjekt (Darstellung Client-abhängig). |
-
Rückgabe:
- 'true' im Erfolgsfall (derzeit immer).
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls dem Report noch kein Template zugewiesen wurde (vgl\.
Report.SetTemplate(...)
).
- Es wird das Void-Objekt zurückgegeben, falls eine ID vorgegeben wurde und kein entsprechendes Element im Abschnitt/Template existiert.
- Es wird das Void-Objekt zurückgegeben, falls ein Element/Template mit gleicher ID existiert, aber einen anderen Assoziationstyp hat (z\.B\. Client-Template oder vorher andere
Set...()
-Funktion benutzt).
|
Isom.Reporting.ReportSection.SetError |
Setzt ein Kontextelement vom Typ "Error"/registrierter Fehler innerhalb des Bericht-Absatzes.
Setzt ein Kontextelement vom Typ "Error"/registrierter Fehler innerhalb des Bericht-Absatzes.
-
Zu beachten:
- Die Darstellung obliegt einem Kontrakt zwischen ISOM/L-Programmen und Anzeigeapplikation (Client).
using Isom.Base.*;
using Isom.Sys.Error;
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
section.SetError( "", error );
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID) oder Leerstring ("") für "ID automatisch vergeben" bzw. "letztes Element des Typs". |
|
err
|
Fehler-Objekt (Darstellung Client-abhängig). |
-
Rückgabe:
- 'true' im Erfolgsfall (derzeit immer).
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls dem Report noch kein Template zugewiesen wurde (vgl\.
Report.SetTemplate(...)
).
- Es wird das Void-Objekt zurückgegeben, falls eine ID vorgegeben wurde und kein entsprechendes Element im Abschnitt/Template existiert.
- Es wird das Void-Objekt zurückgegeben, falls ein Element/Template mit gleicher ID existiert, aber einen anderen Assoziationstyp hat (z\.B\. Client-Template oder vorher andere
Set...()
-Funktion benutzt).
|
Isom.Reporting.ReportSection.SetSeparator |
Setzt ein Trennzeichen-Darstellungselement welches der Client für Formatierungszwecke verwenden kann.
Setzt ein Trennzeichen-Darstellungselement welches der Client für Formatierungszwecke verwenden kann.
-
Zu beachten:
- Die Darstellung obliegt einem Kontrakt zwischen ISOM/L-Programmen und Anzeigeapplikation (Client).
- Für ein zusammenhängendes Beispiel siehe Report.
using Isom.Base.*;
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
section.SetSeparator( "", "COMPLETEPLAN_PARALLEL" );
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID) oder Leerstring ("") für "ID automatisch vergeben" bzw. "letztes Element des Typs". |
|
sepType
|
Separator-Typ oder Void. |
-
Rückgabe:
- 'true' im Erfolgsfall (derzeit immer).
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls dem Report noch kein Template zugewiesen wurde (vgl\.
Report.SetTemplate(...)
).
- Es wird das Void-Objekt zurückgegeben, falls eine ID vorgegeben wurde und kein entsprechendes Element im Abschnitt/Template existiert.
- Es wird das Void-Objekt zurückgegeben, falls ein Element/Template mit gleicher ID existiert, aber einen anderen Assoziationstyp hat (z\.B\. Client-Template oder vorher andere
Set...()
-Funktion benutzt).
|
Isom.Reporting.ReportSection.SetTemplate |
Setzt die ID/den Namen des Templates, der zur Strukturdefinition/Formatierung des Bericht-Absatzes dient.
Setzt die ID/den Namen des Templates, der zur Strukturdefinition/Formatierung des Bericht-Absatzes dient.
-
Zu beachten:
- Welche IDs zulässig sind, obliegt einem Kontrakt zwischen ISOM/L-Programmen und Anzeigeapplikation (Client).
- Für ein zusammenhängendes Beispiel siehe Report.
using Isom.Base.*;
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
section.SetTemplate( "COMPLETEPLAN_PARALLEL" );
-
Parameter:
-
|
templateID
|
technische ID (beliebige Zeichenkette). |
-
Rückgabe:
- eindeutige(r) ID/Namen des Templates (technischen; nicht übersetzbar).
|
Isom.Reporting.ReportSection.SetText |
Setzt ein Darstellungselement vom Typ "Text" innerhalb des Bericht-Absatzes.
Setzt ein Darstellungselement vom Typ "Text" innerhalb des Bericht-Absatzes.
-
Zu beachten:
- Die Darstellung obliegt einem Kontrakt zwischen ISOM/L-Programmen und Anzeigeapplikation (Client).
- Für ein zusammenhängendes Beispiel siehe Report.
using Isom.Base.*;
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
section.SetText( "", "Aktion ausgeführt" );
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID) oder Leerstring ("") für "ID automatisch vergeben" bzw. "letztes Element des Typs". |
|
msg
|
Text-Element (übersetzbare ISOM-Zeichenkette). |
-
Rückgabe:
- 'true' im Erfolgsfall (derzeit immer).
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls dem Report noch kein Template zugewiesen wurde (vgl\.
Report.SetTemplate(...)
).
- Es wird das Void-Objekt zurückgegeben, falls 'Void' als Key übergeben wurde.
- Es wird das Void-Objekt zurückgegeben, falls eine ID vorgegeben wurde und kein entsprechendes Element im Abschnitt/Template existiert.
- Es wird das Void-Objekt zurückgegeben, falls ein Element/Template mit gleicher ID existiert, aber einen anderen Assoziationstyp hat (z\.B\. Client-Template oder vorher andere
Set...()
-Funktion benutzt).
|
Isom.Reporting.ReportSection.SetTherapyPlanAction |
Setzt ein Kontextelement vom Typ "TherapyPlanAction"/Aktion innerhalb des Bericht-Absatzes.
Setzt ein Kontextelement vom Typ "TherapyPlanAction"/Aktion innerhalb des Bericht-Absatzes.
-
Zu beachten:
- Die Darstellung obliegt einem Kontrakt zwischen ISOM/L-Programmen und Anzeigeapplikation (Client).
- Für ein zusammenhängendes Beispiel siehe Report.
using Isom.Base.*;
using Isom.Plan.*;
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
section.SetTherapyPlanAction( "", action );
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID) oder Leerstring ("") für "ID automatisch vergeben" bzw. "letztes Element des Typs". |
|
action
|
Therapieplan-Aktion (Darstellung Client-abhängig). |
-
Rückgabe:
- 'true' im Erfolgsfall (derzeit immer).
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls dem Report noch kein Template zugewiesen wurde (vgl\.
Report.SetTemplate(...)
).
- Es wird das Void-Objekt zurückgegeben, falls eine ID vorgegeben wurde und kein entsprechendes Element im Abschnitt/Template existiert.
- Es wird das Void-Objekt zurückgegeben, falls ein Element/Template mit gleicher ID existiert, aber einen anderen Assoziationstyp hat (z\.B\. Client-Template oder vorher andere
Set...()
-Funktion benutzt).
|
Isom.Reporting.ReportSection.SetTitle |
Setzt die die Überschrift für den Bericht-Absatz.
Setzt die die Überschrift für den Bericht-Absatz.
Die Übergabe von 'Void' setzt die Überschrift zurück.
-
Zu beachten:
- Für ein zusammenhängendes Beispiel siehe Report.
using Isom.Base.*
using Isom.Reporting.*;
...
Report report = Report.CreateReport("FinalReport");
ReportSection section = report.GetSubsection( "Actions" );
section.SetTitle( "Aktionsplan (Parallel-Darstellung)" );
-
Parameter:
-
|
title
|
Absatz-[Unter]Überschrift (übersetzbare ISOM-Zeichenkette). |
-
Rückgabe:
- 'true' im Erfolgsfall (derzeit immer).
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls dem Report noch kein Template zugewiesen wurde (vgl\.
Report.SetTemplate(...)
).
|
Isom.Reporting.ReportSection.SetUserProfileSetting |
Setzt ein Kontextelement vom Typ "UserProfileSetting"/Einstellung innerhalb des Bericht-Absatzes.
Setzt ein Kontextelement vom Typ "UserProfileSetting"/Einstellung innerhalb des Bericht-Absatzes.
-
Zu beachten:
- Die Darstellung obliegt einem Kontrakt zwischen ISOM/L-Programmen und Anzeigeapplikation (Client).
using Isom.Base.*;
using Isom.Sys.Error;
using Isom.Reporting.*;
...
Boolean AddUserProfileDataToReport (UserProfile up)
{
UserProfileSettingList upsList = up.GetSettingsByAssignment( assignment );
upsList.Reset();
while( upsList.HasNext() )
{
UserProfileSetting ups = upsList.Next();
UserProfileOptionList upoList = ups.GetOptions();
while( upoList.HasNext())
{
UserProfileOption upo = upoList.Next();
if( upo.IsCurrent() )
{
userProfileSection.SetUserProfileSetting(ups.GetName(), ups);
}
}
}
return true;
}
-
Parameter:
-
|
key
|
Identifizierende Zeichenkette (techn. ID) oder Leerstring ("") für "ID automatisch vergeben" bzw. "letztes Element des Typs". |
|
setting
|
UserProfileSetting-Objekt (Darstellung Client-abhängig). |
-
Rückgabe:
- 'true' im Erfolgsfall (derzeit immer).
-
Ausnahmebehandlung:
- Es wird das Void-Objekt zurückgegeben, falls dem Report noch kein Template zugewiesen wurde (vgl\.
Report.SetTemplate(...)
).
- Es wird das Void-Objekt zurückgegeben, falls eine ID vorgegeben wurde und kein entsprechendes Element im Abschnitt/Template existiert.
- Es wird das Void-Objekt zurückgegeben, falls ein Element/Template mit gleicher ID existiert, aber einen anderen Assoziationstyp hat (z\.B\. Client-Template oder vorher andere
Set...()
-Funktion benutzt).
|
Isom.Reporting.ReportSection.Void |
Erzeugt ein ungültiges Objekt.
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.