Isom.Exchange.DataDescription

 ISOM/L-Bibliothek für Serviceautoren: <br />Isom.Exchange.DataDescription

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Exchange.DataDescription

Beschreibung

Isom.Exchange.DataDescription sind Datenbeschreibungen, durch die Daten mit den Funktionen in Isom.Exchange.DataExchange gesichert und geladen werden können

Bemerkungen:
Auf der Serviceplattform Taurus® wird zur Datenablage der Dienst Hermes verwendet. Die unterstützten Datenarten werden in der Konfiguration von Hermes festgelegt. Instanzen der Fachklasse Isom.Exchange.DataDescription beschreiben die Daten, auf die zugegriffen wird. Sie legen die Indizes fest, mit denen die Daten gegenüber Hermes identifiziert werden. Ist z. B. wie bei ISOM Didact kein Dienst zur Datenablage vorhanden, muss ein gültiges Datenaustauschverzeichnis für ISOM konfiguriert sein.
Achtung:
Wenn für einen Datentyp Indizes definiert sind, die mit "Vin" beginnen, können diese Indizes automatisch mit der 7-stelligen Fahrgestellnummer aus dem Isom.Context.CurrentVehicleContext befüllt werden. Das erfolgt immer dann, wenn eine entsprechende Datenbeschreibung bei einem Funktionsaufruf übergeben wird, in der ein solcher Index nicht festgelegt ist. Vom Autor gesetzte Indizes werden nicht überschrieben.
Verwendungsbeispiel:

Den dazu passenden Auszug aus einer Hermes-Konfiguration zeigt folgendes Beispiel:


Funktionen

Isom.Exchange.DataDescription.Clone

Erzeugt eine Kopie dieses Objekts.

objectbound Isom.Exchange.DataDescription Isom.Exchange.DataDescription.Clone  (  ) 

Erzeugt eine Kopie dieses Objekts. 

   //Erzeugen einer Instanz 
   Isom.Exchange.DataDescription dataDescription = Isom.Exchange.DataDescription.Create(); 

   //Erzeugen einer Kopie 
   Isom.Exchange.DataDescription clone = dataDescription.Clone();
Rückgabe:
Isom.Exchange.DataDescription
Neue DataDescription mit demselben Inhalt.
Datum:
letzte Änderung am 21.06.2011
Isom.Exchange.DataDescription.Create

Liefert eine neue Instanz.

Isom.Exchange.DataDescription Isom.Exchange.DataDescription.Create  (  ) 

Liefert eine neue Instanz.

In der neuen Instanz sind weder Datentyp noch Schlüssel eingetragen. 

   //Erzeugen der Instanz 
   Isom.Exchange.DataDescription dataDescription = Isom.Exchange.DataDescription.Create();
Rückgabe:
Isom.Exchange.DataDescription
Neue, leere Instanz der Fachklasse.
Datum:
letzte Änderung am 21.06.2011
Isom.Exchange.DataDescription.GetDataType

Gibt den Namen des Typs der beschriebenen Daten zurück.

objectbound Isom.Base.String Isom.Exchange.DataDescription.GetDataType  (  ) 

Gibt den Namen des Typs der beschriebenen Daten zurück.

Die unterstützten Datentypen werden von der verwendeten Datenablage festgelegt 

   //Erzeugen der Instanz 
   Isom.Exchange.DataDescription dataDescription = Isom.Exchange.DataDescription.Create(); 

   //Setzen des Datentyps VehicleOrder 
   dataDescription.SetDataType("VehicleOrder"); 

   //Abfrage des Datentyps 
   Isom.Base.String dataType = dataDescription.GetDataType();
Rückgabe:
Isom.Base.String
Der Name des Datentyps.
Datum:
letzte Änderung am 21.06.2011
Isom.Exchange.DataDescription.GetIndices

Gibt die Indizes der beschriebenen Daten zurück.

objectbound Isom.Base.StringDictionary Isom.Exchange.DataDescription.GetIndices  (  ) 

Gibt die Indizes der beschriebenen Daten zurück.

Die Indizes, mit denen Daten identifiziert werden, werden von der verwendeten Datenablage vorgegeben. 

   //Erzeugen der Instanz 
   Isom.Exchange.DataDescription dataDescription = Isom.Exchange.DataDescription.Create(); 

   //Erzeugen eines Wörterbuchs für die Indizes 
   Isom.Base.StringDictionary indices = Isom.Base.StringDictionary.CreateStringDictionary(); 

   //Eintragen des Index Vin7 in das Wörterbuch 
   indices.Add("Vin7", "1234567"); 

   //Setzen des Datentyps VehicleOrder 
   dataDescription.SetIndices(indices); 

   //Abfrage des Datentyps 
   indices = dataDescription.GetIndices();
Rückgabe:
Isom.Base.StringDictionary
Indizes der beschriebenen Daten.
Datum:
letzte Änderung am 21.06.2011
Isom.Exchange.DataDescription.IsRequired

Gibt an, ob die beschriebenen Daten notwendig für einen Datenimport sind.

objectbound Isom.Base.Boolean Isom.Exchange.DataDescription.IsRequired  (  ) 

Gibt an, ob die beschriebenen Daten notwendig für einen Datenimport sind.

Veraltet:
Veraltet seit Argonaut 1.17. 
   //Erzeugen der Instanz 
   Isom.Exchange.DataDescription dataDescription = Isom.Exchange.DataDescription.Create(); 

   //Abfrage, ob die beschriebene Datei notwendig ist. 
   Isom.Base.Boolean req = dataDescription.IsRequired();
Rückgabe:
Isom.Base.Boolean
'true' genau dann, wenn die Datei notwendig für einen Datenimport ist.
Datum:
letzte Änderung am 21.06.2011
Isom.Exchange.DataDescription.IsVoid

Bestimmt, ob die Aufrufinstanz das Void-Objekt ist.

objectbound Isom.Base.Boolean Isom.Exchange.DataDescription.IsVoid  (  ) 

Bestimmt, ob die Aufrufinstanz das Void-Objekt ist.

Das Void-Objekt wird z. B. geliefert, um einen Fehlerfall anzuzeigen 

   //Erzeugen einer Instanz 
   Isom.Exchange.DataDescription dataDescription = Isom.Exchange.DataDescription.Create(); 

   //Prüfung auf Void 
   if (dataDescription.IsVoid()) 
   { 
     //Fehlerbehandlung 
   }
Rückgabe:
Isom.Base.Boolean
'true' genau dann, wenn dies das Void-Objekt ist.
Datum:
letzte Änderung am 21.06.2011
Isom.Exchange.DataDescription.SetDataType

Legt den Datentyp der beschriebenen Daten fest.

objectbound Isom.Base.Boolean Isom.Exchange.DataDescription.SetDataType  ( Isom.Base.String  dataType  ) 

Legt den Datentyp der beschriebenen Daten fest.

Die unterstützten Datentypen werden von der verwendeten Datenablage festgelegt und können mit Isom.Exchange.DataExchange.GetSupportedDataTypes() abgefragt werden. In dieser Fachfunktion erfolgt keine Prüfung, ob der übergebene Wert unterstützt wird. 

   //Erzeugen der Instanz 
   Isom.Exchange.DataDescription dataDescription = Isom.Exchange.DataDescription.Create(); 

   //Setzen des Datentyps VehicleOrder 
   dataDescription.SetDataType("VehicleOrder");
Parameter:
dataType  Namen des Datentyps.
Rückgabe:
Isom.Base.Boolean
Immer 'true'.
Datum:
letzte Änderung am 21.06.2011
Isom.Exchange.DataDescription.SetIndices

Legt die Indizes der beschriebenen Daten fest.

objectbound Isom.Base.Boolean Isom.Exchange.DataDescription.SetIndices  ( Isom.Base.StringDictionary  indices  ) 

Legt die Indizes der beschriebenen Daten fest.

Die Indizes, mit denen Daten identifiziert werden, werden von der verwendeten Datenablage vorgegeben. In dieser Fachfunktion erfolgt keine Prüfung, ob die übergebenen Werte unterstützt werden. 

   //Erzeugen der Instanz 
   Isom.Exchange.DataDescription dataDescription = Isom.Exchange.DataDescription.Create(); 

   //Erzeugen eines Wörterbuchs für die Indizes 
   Isom.Base.StringDictionary indices = Isom.Base.StringDictionary.CreateStringDictionary(); 

   //Eintragen des Index Vin7 in das Wörterbuch 
   indices.Add("Vin7", "1234567"); 

   //Setzen der Indizes 
   dataDescription.SetIndices(indices);
Parameter:
dataType  Indizes der Daten.
Rückgabe:
Isom.Base.Boolean
Immer 'true'.
Datum:
letzte Änderung am 21.06.2011
Isom.Exchange.DataDescription.SetRequired

Legt fest, ob die beschriebenen Daten notwendig für einen Datenimport sind.

objectbound Isom.Base.Boolean Isom.Exchange.DataDescription.SetRequired  ( Isom.Base.Boolean  required  ) 

Legt fest, ob die beschriebenen Daten notwendig für einen Datenimport sind.

Veraltet:
Veraltet seit Argonaut 1.17. 
   //Erzeugen der Instanz 
   Isom.Exchange.DataDescription dataDescription = Isom.Exchange.DataDescription.Create(); 

   //Festlegung, dass die beschriebene Datei notwendig ist. 
   dataDescription.SetRequired(true);
Parameter:
dataType  'true' für notwendige Daten, 'false' sonst.
Rückgabe:
Isom.Base.Boolean
immer 'true'.
Datum:
letzte Änderung am 21.06.2011
Isom.Exchange.DataDescription.Void

Erzeugt ein Void-Objekt.

Isom.Exchange.DataDescription Isom.Exchange.DataDescription.Void  (  ) 

Erzeugt ein Void-Objekt.

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

   //Erzeuge Void-Objekt 
   Isom.Exchange.DataDescription dataDescription = Isom.Exchange.DataDescription.Void();
Rückgabe:
Isom.Exchange.DataDescription
Ungültiges Objekt.
Ausnahmebehandlung:
Die Funktion liefert immer Void.
Datum:
letzte Änderung am 21.06.2011

Version 9.10.1.0 vom 25 November 2013