Classes in the LDQ API – “Read”

使用する

リーダークラスCL_LDQ_READER

クラスCL_LDQ_READERは、LDQ読み取りのユースケースのキューのテーブルを初期化するのに役立ちます。このクラスは、インターフェースIF_LDQ_READERを実装します。

このクラスのCONFIRM_QUEUE_UNITSメソッドは、暗黙的なコミットを実行する唯一のLDQメソッドです。このクラスの他のすべてのメソッドおよび他のLDQクラスでは、データベースでの作業を永続化するために明示的なコミットが必要です。

UML表現：

属性の概要：

属性	可視性/レベル	説明
M_APPLICATION_NAME	保護されたインスタンス	LDQアプリケーション名

メソッドの概要：

方法	可視性/レベル	説明
SET_QUEUE_NAME	パブリックインスタンス	このメソッドは、LDQユニットリーダーオブジェクトを作成します。このメソッドはLDQキュー名を必要とし、インターフェース参照を返します。キューが別のリーダーによって使用されている場合、メソッドは例外をスローします。
SET_QUEUE_NAME_BY_OFFSET	パブリックインスタンス	キューの読み取りカウンターに指定されたオフセットを使用して、指定されたキューにLDQユニットリーダーオブジェクトを作成します。オフセットが現在の読み取りカウンターよりも大きい場合（=一部のユニットの読み取りをスキップしようとする場合）、例外がスローされます。オフセットが現在のトップカウンターよりも小さい場合（=すでに確認されているユニットの読み取りを試みる）、例外がスローされます。
CONFIRM_QUEUE_UNITS	パブリックインスタンス	ユニットを削除するためのマークは、指定されたシーケンス番号まですでに読み取られています。オフセットカウンターが現在の読み取りカウンターよりも大きい場合（=読み取られなかったユニットの確認を試みる）、例外がスローされます。オフセットカウンターが現在のトップカウンターよりも小さい場合（=すでに確認されているユニットの確認を試みます）、例外がスローされます。注：このメソッドは、 ImplicitCommitを実行します。

方法

可視性/レベル

説明

SET_QUEUE_NAME

パブリックインスタンス

このメソッドは、LDQユニットリーダーオブジェクトを作成します。このメソッドはLDQキュー名を必要とし、インターフェース参照を返します。キューが別のリーダーによって使用されている場合、メソッドは例外をスローします。

SET_QUEUE_NAME_BY_OFFSET

パブリックインスタンス

キューの読み取りカウンターに指定されたオフセットを使用して、指定されたキューにLDQユニットリーダーオブジェクトを作成します。オフセットが現在の読み取りカウンターよりも大きい場合（=一部のユニットの読み取りをスキップしようとする場合）、例外がスローされます。オフセットが現在のトップカウンターよりも小さい場合（=すでに確認されているユニットの読み取りを試みる）、例外がスローされます。

CONFIRM_QUEUE_UNITS

パブリックインスタンス

ユニットを削除するためのマークは、指定されたシーケンス番号まですでに読み取られています。オフセットカウンターが現在の読み取りカウンターよりも大きい場合（=読み取られなかったユニットの確認を試みる）、例外がスローされます。オフセットカウンターが現在のトップカウンターよりも小さい場合（=すでに確認されているユニットの確認を試みます）、例外がスローされます。

注：このメソッドは、 ImplicitCommitを実行します。

ユニットリーダークラスCL_LDQ_UNIT_READER

クラスCL_LDQ_UNIT_READERは、1つ以上のLDQユニットを読み取る目的で、特定のLDQキューへのハンドルを提供します。このクラスは、インターフェースIF_LDQ_UNIT_READERを実装します。

UML表現：

属性の概要：

パブリック属性または保護属性はありません。

メソッドの概要：

方法	可視性/レベル	説明
GET_NEXT_STATES	パブリックインスタンス	次のユニットの状態を読み取ります。このメソッドは、読み取るユニットの数を必要とし、ユニット状態のテーブルを返します。
GET_NEXT_CONTENTS	パブリックインスタンス	次のユニットの内容を読み取ります。このメソッドは、読み取るユニットの数を必要とし、ユニットの内容のテーブルを返します。
GET_TOTAL_NUMBER_OF_UNITS	パブリックインスタンス	キュー内のエントリの総数を取得します。
確認	パブリックインスタンス	すでに読み取ったユニットを削除するためのマーク。
CHECK_READ_SEQUENCE	プライベートスタティック	ユニットが読み取られた順序を確認します。
ON_ROLLBACK	パブリックスタティック	呼び出されたLDQユニットをロールバックします。
AFTER_COMMIT	パブリックスタティック	内部テーブルを削除します。
ON_COMMIT	パブリックスタティック	データベース内の読み取られたLDQユニットを削除します。LDQクラスのすべてのメソッドは、明示的コミットによってデータベース内で作業を永続化します。ただし、IF_LDQ_READERインターフェイスのCONFIRM_QUEUE_UNITSメソッドは、暗黙的コミットを実行します。
CLASS_CONSTRUCTOR	パブリックスタティック	クラスコンストラクタ。
コンストラクタ	パブリックインスタンス	コンストラクタ。

ユニット状態リーダークラスCL_LDQ_UNIT_STATE_READER

クラスCL_LDQ_UNIT_STATE_READERは、1つ以上のLDQユニットの状態データ、つまりユニットサイズ、ユニットフォーマット、およびユニットIDを読み取ります。このクラスは、インターフェースIF_LDQ_UNIT_STATE_READERを実装します。

UML表現：

属性の概要：

パブリック属性または保護属性はありません。

メソッドの概要：

方法	可視性/レベル	説明
GET_FORMAT	パブリックインスタンス	このメソッドは、LDQユニットデータの形式を返します。
GET_UNIT_ID	パブリックインスタンス	このメソッドは、LDQユニットのユニットIDを返します。
GET_SEQUENCE_NUMBER	パブリックインスタンス	このメソッドは、LDQユニットのシーケンス番号を返します。
GET_SUCCESSOR_COUNT	パブリックインスタンス	このメソッドは、キュー内の後続のユニットの数を返します。
GET_SIZE	パブリックインスタンス	このメソッドは、LDQユニットデータのサイズを返します。
GET_DESCRIPTION	パブリックインスタンス	このメソッドは、LDQユニットの追加された説明を返します。
コンストラクタ	パブリックインスタンス	コンストラクタ。コンストラクターには、LDQユニットの状態が必要です。
CHECK_COMMIT_ROLLBACK	プライベートインスタンス	このメソッドは、LDQユニットが有効かどうかをチェックします。

ユニットコンテンツリーダークラスCL_LDQ_UNIT_CONTENT_READER

クラスCL_LDQ_UNIT_CONTENT_READERは、指定されたLDQキュー内の1つ以上のLDQユニットのペイロードを読み取ります。

UML表現：

属性の概要：

パブリック属性または保護属性はありません。

メソッドの概要：

方法	可視性/レベル	説明
GET_CDATA	パブリックインスタンス	このメソッドは、文字のようなデータを読み取ります。このメソッドは文字列を返します。
GET_XDATA	パブリックインスタンス	このメソッドはバイナリデータを読み取ります。このメソッドはバイト文字列を返します。
GET_FORMAT	パブリックインスタンス	このメソッドは、LDQユニットデータの形式を返します。
GET_UNIT_ID	パブリックインスタンス	このメソッドは、LDQユニットのユニットIDを返します。
GET_SEQUENCE_NUMBER	パブリックインスタンス	このメソッドは、LDQユニットのシーケンス番号を返します。
GET_SUCCESSOR_COUNT	パブリックインスタンス	このメソッドは、キュー内の後続のユニットの数を返します。
GET_DESCRIPTION	パブリックインスタンス	このメソッドは、LDQユニットの追加された説明を返します。
GET_SIZE	パブリックインスタンス	このメソッドは、LDQユニットデータのサイズを返します。
コンストラクタ	パブリックインスタンス	コンストラクター。LDQユニットリーダーオブジェクト、ユニット状態、およびユニットデータへの参照が必要です。