Klassen im LDQ API - "Read" (SAP-Bibliothek - Background Communication)"Read"

Klassen im LDQ API - "Read"

Reader Class CL_LDQ_READER

Die Klasse CL_LDQ_READER dient dazu die Queue-Tabelle für den Anwendungsfall LDQ-Reading zu initialisieren. Sie implementiert das Interface IF_LDQ_READER.

Die Methode CONFIRM_QUEUE_UNITS in dieser Klasse ist die einzige LDQ Methode, die einen Implicit Commit ausführt. Alle anderen Methoden dieser Klasse und die anderen LDQ Klassen benötigen ein Explicit Commit, um ihre Arbeit auf der der Datenbank zu behalten.

UML-Darstellung:

Diese Grafik wird im zugehörigen Text erklärt

Überblick der Attribute:

Attribut	Sichtbarkeit / Level	Beschreibung
M_APPLICATION_NAME	Protected Instance	LDQ-Anwendungsname

Überblick der Methoden:

Methode	Sichtbarkeit / Level	Beschreibung
SET_QUEUE_NAME	Public Instance	Die Methode erstellt ein LDQ-Unit-Reader-Object. Die Methode benötigt einen LDQ-Queuenamen und gibt eine Interface-Referenz zurück. Die Methode wirft eine Ausnahme wenn die Queue gerade von einem anderen Benutzer verwendet wird.
SET_QUEUE_NAME_BY_OFFSET	Public instance	Erstellt ein LDQ-Unit-Reader-Object für eine bestimmte Queue mit einem bestimmten Ausgleich für den Lesezähler der Queue. Wenn der Ausgleich (Offset) größer als der aktuelle Lesezähler ist (= Versuch das Lesen einiger Units auszulassen) , so wird eine Ausnahme geworfen. Falls der Offset kleiner als der aktuelle höchste Zähler ist (= Versuch bereits bestätigte einheiten zu lesen), so wird eine Ausnahme geworfen.
CONFIRM_QUEUE_UNITS	Public instance	Markierungen zum Löschen der Einheiten, die bereits bis zu einer bestimmten Abfolgenummer gelesen wurden. Falls der Offset-Zähler größer als der aktuelle Lesezähler ist (= Versuch eine Einheit zu bestätigen, die nie gelesen wurde), so wird eine Ausnahme geworfen. Falls der Offset-Zähler kleiner als der aktuelle höchste Zähler ist (= Versuch Einheiten zu bestätigen, die bereits betätigt wurden), so wird eine Ausnahme geworfen. *Hinweis: Diese Methode führt einen Implicit Commit* durch.**

Unit Reader Class CL_LDQ_UNIT_READER

Die Klasse CL_LDQ_UNIT_READER stellt ein Handle für eine bestimmte LDQ-Queue zur Verfügung mit dem Zweck eine oder mehrere LDQ-Einheiten auszulesen. Die Klasse implementiert das Interface IF_LDQ_UNIT_READER.

UML-Darstellung:

Diese Grafik wird im zugehörigen Text erklärt

Überblick der Attribute:

Keine öffentlichen oder geschützten Attribute.

Überblick der Methoden:

Methode	Sichtbarkeit / Level	Beschreibung
GET_NEXT_STATES	Public Instance	Liest den Zustand der folgenden Einheit. Die Methode benötigt die Anzahl der zu lesenden Einheiten und gibt eine Tabelle mit den Zuständen der Units zurück.
GET_NEXT_CONTENTS	Public Instance	Liest den Inhalt der nächsten Einheit. Die Methode benötigt die Anzahl der zu lesenden Units und gibt eine Tabelle mit dem Inhalt der Units zurück.
GET_TOTAL_NUMBER_OF_UNITS	Public Instance	Ermittelt die Anzahl der Einträge in der Queue.
CONFIRM	Public Instance	Markiert die bereits gelesenen Units für die Löschung.
CHECK_READ_SEQUENCE	Private Static	Überprüfung der Abfolge, in der die Units gelesen wurden.
ON_ROLLBACK	Public Static	Roll-Back aufgerufener LDQ-Units
AFTER_COMMIT	Public Static	Interne Tabellen löschen.
ON_COMMIT	Public Static	Löscht die gelesenen LDQ-Units in der Datenbank. Alle Methoden von LDQ-Klassen persistieren ihre Arbeit auf der Datenbank durch einen Explicit Commit, mit Ausnahme der Methode CONFIRM_QUEUE_UNITS im Interface IF_LDQ_READER, welche einen Implicit Commit ausführt.
CLASS_CONSTRUCTOR	Public Static	Class constructor.
CONSTRUCTOR	Public Instance	Constructor.

Unit State Reader Class CL_LDQ_UNIT_STATE_READER

Die Klasse CL_LDQ_UNIT_STATE_READER liest die Zustandsdaten von einer oder mehreren LDQ-Einheiten, das bedeutet die Größe der Einheit, Format der Einheit und Unit-ID. Die Klasse implementiert das Interface IF_LDQ_UNIT_STATE_READER.

UML-Darstellung:

Diese Grafik wird im zugehörigen Text erklärt

Überblick der Attribute:

Keine öffentlichen oder geschützten Attribute.

Überblick der Methoden:

Methode	Sichtbarkeit / Level	Beschreibung
GET_FORMAT	Public Instance	Die Methode gibt das Format der LDQ-Unit-Daten zurück.
GET_UNIT_ID	Public Instance	Die Methode gibt die Unit-ID der LDQ-Einheit zurück.
GET_SEQUENCE_NUMBER	Public Instance	Die Methode gibt die Abfolgenummer einer LDQ-Einheit an.
GET_SUCCESSOR_COUNT	Public Instance	Die Methode gibt die Nummern der folgenden Einheiten in der Queue an.
GET_SIZE	Public Instance	Die Methode gibt die Größe der LDQ-Unit-daten an.
GET_DESCRIPTION	Public Instance	Die Methode gibt die angehängten Beschreibungen einer LDQ-Einheit an.
CONSTRUCTOR	Public Instance	Constructor. Der Constructor benötigt den zustand der LDQ-Einheit.
CHECK_COMMIT_ROLLBACK	Private Instance	Die Method überprüft, ob die LDQ-Einheit gültig ist.

Unit Content Reader Class CL_LDQ_UNIT_CONTENT_READER

Die Klasse CL_LDQ_UNIT_CONTENT_READER liest die Payload von einer oder mehreren LDQ-Einheiten in einer bestimmten LDQ Queue.

UML-Darstellung:

Diese Grafik wird im zugehörigen Text erklärt

Überblick der Attribute:

Keine öffentlichen oder geschützten Attribute.

Überblick der Methoden:

Methode	Sichtbarkeit / Level	Beschreibung
GET_CDATA	Public Instance	Die Methode liest zeichenähnliche Daten. Die Methode gibt einen Character String zurück.
GET_XDATA	Public Instance	Die Methode liest Binärdaten. Die Methode gibt eine Byte-Zeichenfolge zurück (byte string).
GET_FORMAT	Public Instance	Die Methode gibt das Format der LDQ-Unit Daten zurück.
GET_UNIT_ID	Public Instance	Die Methode gibt die Unit-ID der LDQ-Einheit zurück.
GET_SEQUENCE_NUMBER	Public Instance	Die Methode gibt die Abfolgenummer einer LDQ-Einheit zurück (sequence number).
GET_SUCCESSOR_COUNT	Public Instance	Die Methode gibt die Nummern der folgenden Einheiten in der Queue zurück.
GET_DESCRIPTION	Public Instance	Die Methode gibt die angehängten Beschreibungen einer LDQ-Einheit an.
GET_SIZE	Public Instance	Die Methode gibt die Größe der LDQ-Unit-Daten zurück.
CONSTRUCTOR	Public Instance	Constructor, der eine Referenz zu einem LDQ-Unit-Reader-Object, zum Unit-State und zu der Unit-Data benötigt.