Isom.Exchange.DataExchange

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

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Exchange.DataExchange

Beschreibung

Dieses Fachobjekt ermöglicht eine indexbasierte Verwaltung abgelegter Datensätze. Datensätze können anhand von Beschreibungen als Instanzen der Fachklasse Isom.Exchange.DataDescription gespeichert, gefunden, geladen und gelöscht werden.

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 wie z. B. wie bei ISOM Didact kein Dienst zur Datenablage vorhanden, muss ein gültiges Datenaustauschverzeichnis für ISOM konfiguriert sein.


Funktionen

Isom.Exchange.DataExchange.GetInstance

Liefert die Singleton-Instanz der Fachklasse.

Isom.Exchange.DataExchange Isom.Exchange.DataExchange.GetInstance  (  ) 

Liefert die Singleton-Instanz der Fachklasse.

Liefert die Singleton-Instanz der Fachklasse, auf der instanzgebundene Fachfunktionen aufgerufen werden.

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 
Rückgabe:
Isom.Exchange.DataExchange
Singleton-Instanz der Fachklasse, auf der instanzgebundene Fachfunktionen aufgerufen werden können.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist.
Datum:
letzte Änderung am 09.07.2010
Isom.Exchange.DataExchange.GetSupportedDataTypes

Liefert alle zulässigen Arten von Datensätzen.

objectbound Isom.Base.StringList Isom.Exchange.DataExchange.GetSupportedDataTypes  (  ) 

Liefert alle zulässigen Arten von Datensätzen.

Die Funktion liefert alle Arten von Datensätzen, die in ISOM mit dieser Fachklasse abgespeichert oder geladen werden können.

   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 
   Isom.Base.StringList supportedTypes = dataExchange.GetSupportedDataTypes(); 
   if(supportedTypes.Length().Eq(0)) 
   { 
       //Falls keine Datentypen unterstützt werden 
   } 
Rückgabe:
Isom.Base.StringList
Liste der Namen aller Arten von Datensätzen, die abgespeichert oder geladen werden können. Die Datentypen werden in der verwendeten Datenablage konfiguriert.
Ausnahmebehandlung:
Void wird zurückgegeben, falls die Liste nicht bestimmt werden kann, weil der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist.
Datum:
letzte Änderung am 28.06.2010
Isom.Exchange.DataExchange.IsVoid

Bestimmt, ob die Aufrufinstanz das Void-Objekt ist.

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

Bestimmt, ob die Aufrufinstanz das Void-Objekt ist.

Bestimmt, ob die Aufrufinstanz das Void-Objekt ist. Das Void-Objekt wird z. B. von Isom.Exchange.DataExchange.GetInstance() geliefert, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist.

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 

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

Lädt einen Datensatz.

objectbound Isom.Exchange.DataHandle Isom.Exchange.DataExchange.Load  ( Isom.Exchange.DataDescription  dataDescription  ) 

Lädt einen Datensatz.

Lädt einen Datensatz, der durch den Parameter 'dataDescription' eindeutig identifiziert wird. Geliefert wird eine Instanz der Fachklasse Isom.Exchange.DataHandle als Abstraktion eines Datenstroms, der nicht weiter manipuliert werden kann. Er kann nur als Ein- und Ausgabeparameter der Fachfunktionen in Isom.Exchange.DataExchange verwendet werden. Wird zur Identifizierung des Datensatzes ein Index erwartet, der mit "Vin" beginnt und ist in dem Übergabeparameter für den Index kein Wert vorgegeben, wird von ISOM für diesen Index die 7-stellige Fahrgestellnummer aus dem Istkontext eingetragen. Alle zur Identifizierung des Datensatzes benötigten Indizes, die nicht mit "Vin" beginnen, müssen im Übergabeparameter angegeben sein, so dass sich eine vollständige Beschreibung des zu ladenden Datensatzes ergibt.

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 

   //Datenbeschreibung erzeugen 
   Isom.Exchange.DataDescription description = Isom.Exchange.DataDescription.Create(); 

   //Setzen der Indizes 
   //.. 

   //Einlesen des Datensatzes 
   Isom.Exchange.DataHandle handle = dataExchange.Load(description); 
Parameter:
dataDescription  Beschreibung des zu ladenden Datensatzes.
Rückgabe:
Isom.Exchange.DataHandle
Abstraktion des geladenen Datenstroms.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar oder die Datei nicht vorhanden ist.
Datum:
letzte Änderung am 09.07.2010
Isom.Exchange.DataExchange.LoadDictionary

Lädt ein Wörterbuch.

objectbound Isom.Base.StringDictionary Isom.Exchange.DataExchange.LoadDictionary  ( Isom.Exchange.DataDescription  dataDescription  ) 

Lädt ein Wörterbuch.

Lädt ein Wörterbuch, das als Datensatz abgelegt wurde, der durch den Parameter 'dataDescription' eindeutig identifiziert wird. Alle zur Identifizierung des Datensatzes benötigten Indizes müssen im Übergabeparameter angegeben sein, so dass sich eine vollständige Beschreibung des zu ladenden Datensatzes ergibt.

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 

   //Datenbeschreibung erzeugen 
   Isom.Exchange.DataDescription description = Isom.Exchange.DataDescription.Create(); 

   //Setzen der Indizes 
   //.. 

   //Einlesen des Wörterbuchs 
   Isom.Base.StringDictionary result = dataExchange.LoadDictionary(description); 
Parameter:
dataDescription  Beschreibung des zu ladenden Datensatzes.
Rückgabe:
Isom.Base.StringDictionary
Eingelesenes Wörterbuch.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist oder beim Aufruf einen Fehler geliefert hat.
Datum:
letzte Änderung am 09.07.2010
Isom.Exchange.DataExchange.Lookup

Sucht einen Datensatz.

objectbound Isom.Exchange.DataDescriptionList Isom.Exchange.DataExchange.Lookup  ( Isom.Exchange.DataDescription  dataDescription  ) 

Sucht einen Datensatz.

Sucht Datensätze, die durch den Parameter 'dataDescription' beschrieben werden. Wird zur Beschreibung des Datensatzes ein Index erwartet, der mit der Zeichenkette "Vin" beginnt und ist in dem Übergabeparameter für den Index kein Wert vorgegeben, wird von ISOM für diesen Index die 7-stellige Fahrgestellnummer aus dem Istkontext eingetragen. Indizes, die in dem Übergabeparameter angegeben wurden werden unverändert weitergegeben, so dass auch Suchmuster, wie z. B. "*", als Wert eines Index erlaubt sind, sofern der angebundene Dienst zur Datenablage dies unterstützt.

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 

   //Datenbeschreibung erzeugen 
   Isom.Exchange.DataDescription description = Isom.Exchange.DataDescription.Create(); 

   //Setzen der Indizes 
   //.. 

   //Suchen von Datensätzen 
   Isom.Exchange.DataDescriptionList results = dataExchange.Lookup(description)) 
Parameter:
dataDescription  Beschreibung der gesuchten Datensätze.
Rückgabe:
Isom.Exchange.DataDescriptionList
Liste mit gefundenen Datensätzen.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist.
Datum:
letzte Änderung am 09.07.2010
Isom.Exchange.DataExchange.Remove

Löscht einen Datensatz.

objectbound Isom.Base.Boolean Isom.Exchange.DataExchange.Remove  ( Isom.Exchange.DataDescription  dataDescription  ) 

Löscht einen Datensatz.

Löscht einen Datensatz, der durch den Parameter 'dataDescription' eindeutig identifiziert wird. Wird zur Identifizierung des Datensatzes ein Index erwartet, der mit der Zeichenkette "Vin" beginnt und ist in dem Übergabeparameter für den Index kein Wert vorgegeben, wird von ISOM für diesen Index die 7-stellige Fahrgestellnummer aus dem Istkontext eingetragen. Alle zur Identifizierung des Datensatzes benötigten Indizes, die nicht mit "Vin" beginnen, müssen im Übergabeparameter angegeben sein, so dass sich eine vollständige Beschreibung des zu löschenden Datensatzes ergibt.

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 

   //Datenbeschreibung erzeugen 
   Isom.Exchange.DataDescription description = Isom.Exchange.DataDescription.Create(); 

   //Setzen der Indizes 
   //.. 

   //Löschen des Datensatzes 
   if (dataExchange.Remove(description).Failed()) 
   { 
     //Fehlerbehandlung 
   } 
Parameter:
dataDescription  Beschreibung des zu löschenden Datensatzes.
Rückgabe:
Isom.Base.Boolean
'true' genau dann, wenn der Vorgang erfolgreich war.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist oder beim Aufruf einen Fehler geliefert hat.
Datum:
letzte Änderung am 09.07.2010
Isom.Exchange.DataExchange.RemoveDataByCurrentVin

Löscht alle Datensätze für die aktuell eingestellte Fahrgestellnummer

objectbound Isom.Base.Boolean Isom.Exchange.DataExchange.RemoveDataByCurrentVin  (  ) 

Löscht alle Datensätze für die aktuell eingestellte Fahrgestellnummer

Die Funktion löscht alle Datensätze, die für die aktuell eingestellte Fahrgestellnummer abgespeichert wurden. Berücksichtigt werden alle Daten, die einen Schlüssel benötigen, der mit "Vin" beginnt.

   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 
   if(dataExchange.RemoveDataByCurrentVin().Failed()) 
   { 
       //Daten konnten nicht gelöscht werden 
   } 
Rückgabe:
Isom.Base.Boolean
Liefert 'true', wenn Daten gelöscht wurden, 'false' sonst.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist.
Datum:
letzte Änderung am 28.06.2010
Isom.Exchange.DataExchange.RemoveDictionary

Löscht den Datensatz eines Wörterbuchs.

objectbound Isom.Base.Boolean Isom.Exchange.DataExchange.RemoveDictionary  ( Isom.Exchange.DataDescription  dataDescription  ) 

Löscht den Datensatz eines Wörterbuchs.

Löscht ein als Datensatz, der durch den Parameter 'dataDescription' eindeutig identifiziert wird, abgelegtes Wörterbuch. Alle zur Identifizierung des Datensatzes benötigten Indizes müssen im Übergabeparameter 'dataDescription' angegeben sein, so dass sich eine vollständige Beschreibung des zu entfernenden Datensatzes ergibt.

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 

   //Datenbeschreibung erzeugen 
   Isom.Exchange.DataDescription description = Isom.Exchange.DataDescription.Create(); 

   //Setzen der Indizes 
   //.. 

   //Löschen des Datensatzes des Wörterbuchs 
   if (dataExchange.RemoveDictionary(description).Failed()) 
   { 
     //Fehlerbehandlung 
   } 
Parameter:
dataDescription  Beschreibung des zu löschenden Datensatzes.
Rückgabe:
Isom.Base.Boolean
'true' genau dann, wenn der Vorgang erfolgreich war.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist oder beim Aufruf einen Fehler geliefert hat.
Datum:
letzte Änderung am 09.07.2010
Isom.Exchange.DataExchange.RemoveFromDictionary

Entfernt einen Eintrag aus einem als Datensatz abgelegten Wörterbuch.

objectbound Isom.Base.Boolean Isom.Exchange.DataExchange.RemoveFromDictionary  ( Isom.Exchange.DataDescription  dataDescription,
Isom.Base.String  key  )

Entfernt einen Eintrag aus einem als Datensatz abgelegten Wörterbuch.

Entfernt einen Eintrag aus einem als Datensatz, der durch den Parameter 'dataDescription' eindeutig identifiziert wird, abgelegten Wörterbuch. Alle zur Identifizierung des Datensatzes benötigten Indizes müssen im Übergabeparameter angegeben sein, so dass sich eine vollständige Beschreibung des zu entfernenden Datensatzes ergibt. Ist für das Wörterbuch kein Datensatz vorhanden, wird ein neuer Datensatz erzeugt und abgelegt.

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 

   //Datenbeschreibung erzeugen 
   Isom.Exchange.DataDescription description = Isom.Exchange.DataDescription.Create(); 

   //Setzen der Indizes 
   //.. 

   //Entfernt den Schlüssel "Test" aus dem abgelegten Wörterbuch 
   if (dataExchange.RemoveFromDictionary(description, "Test").Failed()) 
   { 
     //Fehlerbehandlung 
   } 
Parameter:
dataDescription  Beschreibung des Datensatzes des Wörterbuchs.
key  Schlüssel, der aus dem als Datensatz abgelegten Wörterbuch entfernt wird
Rückgabe:
Isom.Base.Boolean
'true' genau dann, wenn der Vorgang erfolgreich war.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist oder beim Aufruf einen Fehler geliefert hat.
Datum:
letzte Änderung am 09.07.2010
Isom.Exchange.DataExchange.Store

Speichert einen Datensatz.

objectbound Isom.Base.Boolean Isom.Exchange.DataExchange.Store  ( Isom.Exchange.DataDescription  dataDescription,
Isom.Exchange.DataHandle  input  )

Speichert einen Datensatz.

Speichert einen Datensatz, der durch den Parameter 'dataDescription' eindeutig identifiziert wird. Wird zur Identifizierung des Datensatzes ein Index erwartet, der mit "Vin" beginnt und ist in dem Übergabeparameter für den Index kein Wert vorgegeben, wird von ISOM für diesen Index die 7-stellige Fahrgestellnummer aus dem Istkontext eingetragen. Alle zur Identifizierung des Datensatzes benötigten Indizes, die nicht mit "Vin" beginnen, müssen im Übergabeparameter angegeben sein, so dass sich eine vollständige Beschreibung des zu speichernden Datensatzes ergibt.

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 

   //Datenbeschreibung erzeugen 
   Isom.Exchange.DataDescription description = Isom.Exchange.DataDescription.Create(); 

   //Setzen der Indizes 
   //.. 

   //Einlesen des Datensatzes 
   Isom.Exchange.DataHandle handle = dataExchange.Load(description); 

   //Speichern des Datensatzes 
   if (dataExchange.Store(description, handle).Failed()) 
   { 
     //Fehlerbehandlung 
   } 
Parameter:
dataDescription  Beschreibung des zu speichernden Datensatzes.
input  Die zu speichernden Daten
Rückgabe:
Isom.Base.Boolean
'true' genau dann, wenn der Vorgang erfolgreich war.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist oder beim Aufruf einen Fehler geliefert hat.
Datum:
letzte Änderung am 09.07.2010
Isom.Exchange.DataExchange.StoreDictionary

Speichert ein Wörterbuch.

objectbound Isom.Base.Boolean Isom.Exchange.DataExchange.StoreDictionary  ( Isom.Exchange.DataDescription  dataDescription,
Isom.Base.StringDictionary  dictionary  )

Speichert ein Wörterbuch.

Speichert ein Wörterbuch 'dictionary' als Datensatz, der durch den Parameter 'dataDescription' eindeutig identifiziert wird. Alle zur Identifizierung des Datensatzes benötigten Indizes müssen im Übergabeparameter angegeben sein, so dass sich eine vollständige Beschreibung des zu speichernden Datensatzes ergibt.

   StringDictionary dict = StringDictionary.CreateStringDictionary(); 

   //Befüllen des Wörterbuchs 
   //.. 

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 

   //Datenbeschreibung erzeugen 
   Isom.Exchange.DataDescription description = Isom.Exchange.DataDescription.Create(); 

   //Setzen der Indizes 
   //.. 

   //Speichern des Wörterbuchs als Datensatz 
   if (dataExchange.StoreDictionary(description, dict).Failed()) 
   { 
     //Fehlerbehandlung 
   } 
Parameter:
dataDescription  Beschreibung des zu speichernden Datensatzes.
dictionary  Zu speicherndes Wörterbuch.
Rückgabe:
Isom.Base.Boolean
'true' genau dann, wenn der Vorgang erfolgreich war.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist oder beim Aufruf einen Fehler geliefert hat.
Datum:
letzte Änderung am 09.07.2010
Isom.Exchange.DataExchange.UpdateDictionary

Aktualisiert ein Wörterbuch.

objectbound Isom.Base.Boolean Isom.Exchange.DataExchange.UpdateDictionary  ( Isom.Exchange.DataDescription  dataDescription,
Isom.Base.StringDictionary  dictionary  )

Aktualisiert ein Wörterbuch.

Aktualisiert ein als Datensatz, der durch den Parameter 'dataDescription' eindeutig identifiziert wird, abgelegtes Wörterbuch. Alle zur Identifizierung des Datensatzes benötigten Indizes müssen im Übergabeparameter angegeben sein, so dass sich eine vollständige Beschreibung des zu aktualisierenden Datensatzes ergibt. Ist für das Wörterbuch kein Datensatz vorhanden, wird ein neuer Datensatz erzeugt und abgelegt.

   StringDictionary dict = StringDictionary.CreateStringDictionary(); 

   //Befüllen des Wörterbuchs 
   //.. 

   //Abfrage der Zugriffsinstanz 
   Isom.Exchange.DataExchange dataExchange = Isom.Exchange.DataExchange.GetInstance(); 

   //Datenbeschreibung erzeugen 
   Isom.Exchange.DataDescription description = Isom.Exchange.DataDescription.Create(); 

   //Setzen der Indizes 
   //.. 

   //Aktualisieren des Datensatzes des Wörterbuchs 
   if (dataExchange.UpdateDictionary(description, dict).Failed()) 
   { 
     //Fehlerbehandlung 
   } 
Parameter:
dataDescription  Beschreibung des zu aktualisierenden Datensatzes.
dictionary  Aktualisierendes Wörterbuch.
Rückgabe:
Isom.Base.Boolean
'true' genau dann, wenn der Vorgang erfolgreich war.
Ausnahmebehandlung:
Void wird zurückgegeben, falls der zur Nutzung dieser Fachklasse benötigte Dienst zur Datenablage nicht erreichbar ist oder beim Aufruf einen Fehler geliefert hat.
Datum:
letzte Änderung am 09.07.2010
Isom.Exchange.DataExchange.Void

Erzeugt ein Void-Objekt.

Isom.Exchange.DataExchange Isom.Exchange.DataExchange.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.DataExchange dataExchange = Isom.Exchange.DataExchange.Void(); 
Rückgabe:
Isom.Exchange.DataExchange
Die Funktion liefert immer ein Void-Objekt.
Ausnahmebehandlung:
Die Funktion liefert immer Void.
Datum:
letzte Änderung am 09.07.2010

Version 9.10.1.0 vom 25 November 2013