X++ クラスライブラリ

[アーティクル]
03/08/2023

この記事では、X++ のクラスライブラリについて説明します。

アプリケーションクラスおよびシステムクラスの、2 種類のクラスがあります。

アプリケーションクラス - これらのクラスは X++ で実装されています。これらはアプリケーションエクスプローラーの コード > クラス ノードで使用できます。
システムクラス – これらのクラスは、カーネルクラス と呼ばれることもあります。これは、アプリケーションエクスプローラーの システムドキュメント > クラス ノードの下に一覧表示されます。これらのクラスのソースコードは使用できません。システムクラスの一覧については、API、クラス、およびテーブルの参照を参照してください。

アプリケーションクラスの一般的な構造

次のコードブロックタイプは、アプリケーションクラスの標準です。

クラスおよび変数宣言: このクラス宣言には、パブリック、プライベート、および拡張などのクラスモディファイアーが含まれます。
変数宣言: これらは、このクラスから構築されたオブジェクトのフィールドメンバーです。 this というキーワードをクラスインスタンス変数に入力すると、IntelliSense でこのメンバーを一覧表示できます。
新規メソッド: このメソッドは、クラスのインスタンスを作成します。コンストラクターは、新しいキーワードを使用することによってのみ呼び出すことができます。派生クラスは、super メソッドの参照を呼ぶことにとって、コントラクターの新しいメソッドを呼び出すことができます。詳細については、X++ 継承を参照してください。
ファイナライズ メソッド: このメソッドは、クラスのインスタンスをファイナライズします。このメソッドはデストラクターメソッドです。ただし、規則のみのデストラクタです。ガベージコレクション中に finalize メソッドが自動的に呼び出されることはありません。

クラスの追加メソッドには、次のタイプがあります。

インスタンスメソッド
静的メソッド
主要メソッド

さまざまな種類の項目でメソッドを作成することができます。次にいくつか例を挙げます。

クラス
マップ
ビュー
データセット
フォーム
クエリ

システムクラス用のアプリケーションクラスの置き換え

拡張するシステムクラスの代わりに アプリケーションクラスの置き換え を使用する必要があります。

アプリケーションエクスプローラーの、システムドキュメント > クラス では、いくつかのカーネルまたはシステムクラスの名前は小文字の x で始まります。これらのクラスは、x-system classes とも呼ばれています。これらのシステムクラスの例には、xApplication および xVersionControl が存在します。これらのクラスのいくつかは、アプリケーションクラスによって拡張されます。たとえば、アプリケーションクラスは xApplication システムクラスを拡張します。

X システムクラスから派生するクラスは、アプリケーションクラスの代用 として知られています。アプリケーションエクスプローラーのクラス ノードで、代替アプリケーションクラスの横にあるアイコンは標準のアイコンと異なります。

x システムクラス

代替アプリケーションクラスの一部は、クラスのインスタンスを表す特殊なグローバル変数に関連付けられます。たとえば、appl 変数は、アプリケーションクラスから事前にインスタンス化されたオブジェクトを参照します。 appl 変数の利点は、セッションの範囲全体にわたってシステムがオブジェクトを保持することです。 Application クラスのインスタンスを取得するために new Application() 構文を繰り返し使用した場合、コードの効率が低下します。 xApplication システムクラスは使用しないでください。代わりに、アプリケーションの代替アプリケーションクラスを使用します。

標準構文 Application::checkForNewBatchJobs() を使用することにより、アプリケーション クラスの静的メンバーを参照することができます。ただし、アプリケーションクラスのインスタンスメンバーを参照するには、そのクラスの appl 変数 (存在する場合) を使用する必要があります。このパターンは、ほとんどの x システムクラスに適用されます。 セッション 代替アプリケーションクラスは、セッション の特殊なグローバル変数がないため 1 つの例外です。

次のテーブルは、対応するアプリケーションクラスの代用を持つ x システムクラスの一覧です。特殊なグローバル変数は、それらを持つクラスに対しても表示されます。

アプリケーションクラス	x システムクラス	グローバル変数
引数	xArgs	該当なし
申請	xApplication	appl
ClassFactory	xClassFactory	classFactory
法人	xCompany	appl.company
グローバル	xGlobal	該当なし
情報	xInfo	情報ログ
MenuFunction	xMenuFunction	該当なし
セッション	xSession	該当なし
VersionControl	xVersionControl	versionControl

x システムクラスの例

次の例は、代替アプリケーションクラスのインスタンスを参照するいくつかの特殊な変数を使用するための構文を示しています。

TreeNode treeNode;
Args     args;
FormRun  formRun;

// appl variable
info(appl.buildNo());

// company variable
appl.company().reloadRights();

// infolog variable
treeNode = infolog.findNode("\\forms\\custTable");
info(treeNode.AOTgetProperty("Name"));
// Output is "CustTable".

// classFactory variable
args = new Args(formstr(Batch));
formRun = classFactory.formRunClass(args);
formRun.init();
formRun.run();
formRun.detach();
info("Method is ending. This is a message in the Infolog.");
// Output is "Method is ending. This is a message in the Infolog."

バッチ処理クラス

クラスを実装するには、バッチ処理システムを使用し、RunBase および RunBaseBatch クラスを拡張します。 バッチ処理ダイアログボックスから繰り返しボタンを削除するには、Args::parmEnum メソッドを使用します。サーバーバインドバッチメソッドとして実行するクラスを指定することをお勧めします。サーバーバインドバッチメソッドは、以下の理由のため、サーバーバインドでないバッチメソッドより安全です。

このメソッドは、メソッドを送信したユーザーのアクセス許可を使用して実行されます。
このメソッドは、特定の情報および グローバル クラスメソッドのみを使用して、それを処理しているクライアントと対話できます。この制限により、クライアントとのやり取りが制限されます。

サーバーバインドバッチメソッドとして実行するクラスを有効化

RunBaseBatch クラスを拡張するクラスを作成します。
次の例に示すように、RunBaseBatch.runsImpersonated メソッドをオーバーライドし、値 true を返します。
```
public boolean runsImpersonated()
{
    return true;
}
```
クラスが次の情報およびグローバルクラスのメソッドのみを呼び出すことを確認します。
- 追加
- Info.copy
- Info.cut
- Info.import
- Info.export
- Info.line
- Info.num
- Global::error
- Global::info
- Global::warning
Info.line および Info.num メソッドは、xInfo クラスから継承されます。

バッチ処理ダイアログボックスから定期的なアイテムを削除

バッチ処理システムを使用してクラスを実装するときは、Args.parmEnum メソッドを呼び出し、NoYes::Yes システム列挙値を渡して、再実行ボタンを削除できます。 NoYes システム列挙は、繰り返し ボタンがダイアログボックスから削除されるかどうかを決定します。既定値は NoYes::No です。

次の例では、InventTransferMultiShip クラスが実装されています。 BatchDialog::main メソッドは、バッチ処理ダイアログボックスを作成します。

static void noRecurrenceButton(Args _args)
{
    Args a;
    InventTransferMultiShip inventTransferMultiShip;
    a = new Args();
    inventTransferMultiShip = InventTransferMultiShip::construct();
    a.caller(inventTransferMultiShip);
    a.parmEnum(NoYes::Yes);
    BatchDialog::main(a);
}

イメージ操作クラス

Image と Imagelist の 2 つのシステムクラスにより、グラフィックスとアイコンを操作できます。

Image – このクラスでは、個々の画像の読み込み、保存、操作などができます。たとえば、画面をキャプチャして画像として保存し、画像をトリミングまたは回転させる、または色深度を操作します。
Imagelist - このクラスを使用すると、サイズや透明色などの一般的なプロパティを持つ一連の画像を操作できます。 ImageListAppl アプリケーションクラスで使用されるイメージリストを表示できます。

クエリオブジェクトモデル

クエリオブジェクトモデルには、クエリの定義と実行に使用されるクラスが含まれています。クエリオブジェクトは、クエリデータソース、返されるフィールド、レコード範囲、子データソースとの関係を定義するために使用されます。動的クエリをコードで作成すると、クエリクラスの可視性が高まります。さらに、これらは、アプリケーションエクスプローラーで静的クエリを作成するときにもシーン裏で使用されます。

次のテーブルでは、クエリオブジェクトモデルのクラスについて説明します。

システムクラス	説明
QueryRun	このクラスは、クエリを実行し、データをフェッチします。
クエリ	このクラスはいくつかのプロパティを保持し、1 つ以上の関連するデータソースを持ちます。クエリの定義の最上位です。
QueryBuildDataSource	このクラスは、クエリ内の単一のデータソースへのアクセスを定義します。クエリに同じレベルの 1 つ以上のデータソースある場合、独立した SQL ステートメントが生産され、順番に実行されます。データソースが別のデータソースの子である場合は、2 つのデータソース間に結合が作成されます。
QueryBuildFieldList	このクラスは、データベースから返されるフィールドを定義します。既定では、フィールドリストは動的であり、すべてのフィールドはデータソーステーブル、マップ、またはビューから戻されます。各データソースには、QueryBuildFieldList オブジェクトが 1 つだけあります。このオブジェクトには、選択したすべてのフィールドに関する情報が含まれます。フィールドリストオブジェクトで、SUM、COUNT、および AVG などの、集計関数を指定することができます。
QueryBuildRange	このクラスは、単一フィールドに基づいて、返されるレコードのサブセットを定義します。範囲は、クエリ SQL ステートメントの WHERE 句に変換されます。クエリを制限するために 1 つ以上のフィールドが使用されている場合 (WHERE句)、データソースには 1 つ以上の範囲が含まれます。
QueryBuildDynalink	このクラスには、外部レコードとの関係 (制限) に関する情報が含まれます。クエリを実行すると、この情報は、クエリ SQL ステートメントの WHERE 句内で追加のエントリに変換されます。このクラスは、クエリの親データソースにのみ存在できます。フォームは、2 つのデータソースが同期されるときにこの機能を使用します。子データソースは、親データソースに対する 1 つ以上の DLL を格納します。この関数は、2 つのデータソースが 2 つの異なる形式になっていて、まだ同期されている場合でも使用されます。
QueryBuildLink	このクラスは、結合に 2 つのデータソースの間の関係を指定します。このクラスは、子データソースにのみ存在できます。

また、SysDa APIを使用してデータを照会することもできます。

システムクラスの概要

システムクラスのこのソースは使用できません。システムクラスは、次の特性を持つことができます。

静的メソッド (またはクラスメソッド)
動的メソッド
プロパティ - これらのプロパティは、プロパティを設定するために使用されるメンバー関数です。たとえば LeftMargin です。

システムクラスのメソッドをオーバーライドすることはできません。最初からアプリケーションオブジェクトをデザインするためにシステムクラスを使用することを意図していません。代わりに、アプリケーションエクスプローラーで既存の機能を拡張または変更するために使用します。たとえば、既存のレポートに追加情報を動的に追加することができます。または、前のページでのユーザーの選択に基づいて、ページ上で使用可能なオプションを変更することができます。

コレクションクラス

コレクションクラスを使用すると、リスト、セット、構造体、マップ、および配列を作成できます。

アプリケーションオブジェクトクラス

これらのシステムクラスは、アプリケーションエクスプローラーを使用してアプリケーションを作成するたびにアクティブ化される関数を保持します。たとえば、システムは、アプリケーションエクスプローラーの設計ノードでフォームのレイアウトを定義する時、FormDesign クラスを使用します。これらのクラスを使用すると、アプリケーションオブジェクトを作成したり変更したりすることもできます。

統合クラス

環境との統合は、通常、クラスによって実装されます。このカテゴリ内のクラスの例を次に示します。

COM - COM オブジェクトのメソッドの呼び出しです。
DLL – Microsoft Windows DLL 関数の呼び出し。
IO – 外部ファイルの読み取りと書き込みを行います。
ODBCConnection – 外部データベースへの Open Database Connectivity (ODBC) インターフェイス。

次の方法で共有

X++ クラスライブラリ

アプリケーションクラスの一般的な構造

システムクラス用のアプリケーションクラスの置き換え

x システムクラス

x システムクラスの例

バッチ処理クラス

サーバーバインドバッチメソッドとして実行するクラスを有効化

バッチ処理ダイアログボックスから定期的なアイテムを削除

イメージ操作クラス

クエリオブジェクトモデル

システムクラスの概要

コレクションクラス

アプリケーションオブジェクトクラス

統合クラス

フィードバック

その他のリソース

次の方法で共有

X++ クラス ライブラリ

アプリケーション クラスの一般的な構造

システム クラス用のアプリケーション クラスの置き換え

x システム クラス

x システム クラスの例

バッチ処理クラス

サーバー バインド バッチ メソッドとして実行するクラスを有効化

バッチ処理ダイアログ ボックスから定期的なアイテムを削除

イメージ操作クラス

クエリ オブジェクト モデル

システム クラスの概要

コレクション クラス

アプリケーション オブジェクト クラス

統合クラス

フィードバック

その他のリソース

X++ クラスライブラリ

アプリケーションクラスの一般的な構造

システムクラス用のアプリケーションクラスの置き換え

x システムクラス

x システムクラスの例

サーバーバインドバッチメソッドとして実行するクラスを有効化

バッチ処理ダイアログボックスから定期的なアイテムを削除

クエリオブジェクトモデル

システムクラスの概要

コレクションクラス

アプリケーションオブジェクトクラス