承認テストライブラリのエンティティ

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

テストエンティティクラスは、単一の概念として認識されるデータと動作を表します。テストエンティティクラスは 販売注文、移動オーダー、そして リリースされた製品 のようなページに基づいています。テストエンティティクラスは、テストシナリオで最も頻繁に使用されるプロパティと、テストデータの設定やシナリオテストの観点から最も重要な動作を公開します。

承認テストライブラリ (ATL) のエンティティには、次のメソッドが必ず必要です:

エンティティのプロパティを取得および設定するために使用されるプロパティメソッド。
エンティティプロパティを Fluent な方法で設定できるように有効化する Fluent セッターメソッド。
エンティティをデータベースに保存するメソッド。

ATL のエンティティは、次のメソッドを持つことが可能です:

エンティティに関連する事業運営を公開するために使用されるアクションメソッド。
コンポーネントおよび関連エンティティに対してナビゲーションを有効にするのに使用されるクエリメソッド。

名前付け規則

[AtlEntity]<ModuleName><EntityName>

この命名規則で:

<ModuleName> はメインメニューのモジュール名に基づいています。短いテストコードをサポートするために、短いバージョンまたは省略形を使用する必要があります。
<EntityName> はテーブル名の代わりにユーザーインターフェイス (UI) 名に基づいています。たとえば、SalesTable ではなく SalesOrder を使用します。

エンティティに 2 つの UI 名がある場合は、短い方の名前を使用できます。たとえば、代替可能な名前であるため ReleasedProduct の代わりに Item を使用できます。

例

AtlEntitySalesOrder

AtlEntityTransferOrderLine

プロパティメソッド

テストエンティティの主な目的のひとつは、データを公開することです。エンティティのプロパティは parm (プロパティ) メソッドを使用して設定または取得できます。

プリミティブ型のプロパティ

プリミティブ型のプロパティを公開するための parm メソッドを作成します。

例

public SalesQty parmQuantity(SalesQty _qty = 0)
{
    if (!prmisDefault(_qty))
    { // setter
        salesLine.SalesQty = _qty;
        this.onSalesQtyOrInventDimChange();
    }
    return salesLine.SalesQty;
}

エンティティ参照

たとえば AtlEntityCustomer という名前の顧客エンティティがある場合、AtlEntitySalesOrder エンティティのプロパティメソッドとして customer への参照を公開する必要があります。

public AtlEntityCustomer parmCustomer(AtlEntityCustomer _custTable = null)

プロパティメソッドをセッターやゲッターとして使用できます。

salesOrder.parmCustomer(customer); // setter

customer = salesOrder.parmCustomer(); // getter

エンティティ参照メソッドの命名規則

プロパティメソッドを識別するために parm プレフィックスを使用する必要があります。エンティティ参照プロパティを公開するときは、アプリケーションオブジェクトツリー (AOT) 名の代わりにフィールドの UI 名を使用します。 UI 名に Id、Code、または Number 接尾語が含まれている場合は、その接尾語を省略します。たとえば、parmItemNumber の代わりに parmItem を使用します。

レコード参照

顧客エンティティがまだ作成されておらず、近い将来にも作成されない場合、参照プロパティは対応するレコードバッファ (CustTable) を公開する必要があります。

public CustTable parmCustomer(CustTable _custTable = null)

レコード参照の命名規則

エンティティ参照に使用されているのと同じ命名規則を使用してください。

ID 参照

エンティティやレコード参照を持つことに加えて、Id 参照プロパティを導入できます。

public CustAccount customerId(CustAccount _custTable = null)

対応するエンティティまたはバッファー参照も導入しない限り、Id 参照を導入しないでください。 Id 参照は、エンティティやバッファー参照メソッドへのショートカットです。 Id 参照の実装は、エンティティやバッファー参照に呼び出しを委任する必要があります。

ID 参照の命名規則

Id、Number、Account、Code、また Name などの語句が含まれる場合は UI 名を使用してください。それ以外の場合、エンティティやレコード参照の名前に適切な接尾語を追加します。

ID 参照メソッドの契約

Id 参照メソッドは参照エンティティを見つけるために常に提供された Id を使用し、そしてエンティティやレコード参照メソッドに呼び出しを委任します。指定された Id 値に基づいてエンティティやレコードが見つからない場合は、エラーメッセージがスローされます。

Fluent セッターメソッド

Fluent な初期化とエンティティの変更をサポートする Fluent なセッターメソッドを作成します。

宣言の例

public AtlEntitySalesLine setQty(SalesQty _qty)

コードの例

salesLine.setItem(batchItem).setInventDims([warehouse]).setQty(10).save();

名前付け規則

set<PropertyName>

この命名規則では <PropertyName> が対応するプロパティメソッドの名前で使用されているものと一致する必要があります。

アクションメソッド

エンティティはデータだけでなく関連するアクションも表します。アクションは単純なアクションメソッドとしても、コマンドオブジェクト初期化子としても実装できます。

単純なアクションメソッド

単純なアクションメソッドは、完全なアクションを表します。これらを Fluent に連鎖してはいけません。例外は save メソッドで、Fluent である必要があります。

名前付け規則

<ExecuteBusinessOperation>

この命名規則では <ExecuteBusinessOperation> は事業運営を表す動詞です。それは UI のメニュー項目で使用されているのと同じ用語である必要があります。

例

salesOrder.save();

salesOrder.postInvoice();

コマンドオブジェクト初期化子

コマンドオブジェクト初期化子は、コマンドのパラメーターを指定し実行できるコマンドオブジェクトを返します。

transferLine.pick().setQty(10).setWMSLocation(bulkLocation).execute();

名前付け規則

<ExecuteBusinessOperation>

例

salesOrder.pick().execute();

purchaseOrder.register().execute();

アクションエンティティ

エンティティで利用可能ないくつかのアクションは、エンティティそのものと考えることができます。仕入先の請求書がひとつの例です。請求書を転記する前に、請求書のパラメータを設定し、行を編集して、後のために請求書を保存することができます。これらのコマンドは、個別のエンティティクラスを導入できます。

名前付け規則

new<ActionName>

この命名規則では <ActionName> は事業運営を表す名詞です。名前は事業運営の UI 名にする必要があります。

例

receipt = transfer.newReceipt().setEditLines(true).setExplodeLines(true);
receipt.lines().withBatch(batch1).single().setReceiptQty(6).setScrapQty(1).save();
receipt.lines().withBatch(batch2).single().setReceiptQty(4).setScrapQty(1).save();
receipt.post();

クラスの命名規則

AtlEntity<ModuleName><EntityName><ActionName>

例

AtlEntityInventTransferOrderReceipt

コンポーネントの追加

コンポジションは複合エンティティがコンポーネントパーツの配置に対して唯一の責任を持つ関係です。複合オブジェクトがコンポーネントの所有権を持っているため、複合とコンポーネントの関係は強い "持っている" の関係です。したがって、複合はコンポーネントパーツの作成と破棄を担当します。

オブジェクトインスタンスのひとつを、ひとつの複合の一部にすることができます。複合オブジェクトが破棄された場合は、すべてのコンポーネントパーツを破棄する必要があります。コンポーネントパーツは複合オブジェクトの外部に独立した存在を持たず、他のオブジェクトに転送することはできません。コンポーネントパーツは通常は複合オブジェクトのメンバーであるため、合成はカプセル化を強制します。

複合オブジェクトの例は、元伝票行で構成されている元伝票です。

例

元伝票の例では、ドキュメントエンティティは複合ルートとして機能し、ドキュメント行の新しいインスタンスの作成に責任があります。この場合、元伝票エンティティはドキュメントの新しい行を初期化して返す addLine() メソッドを持ちます。

public AtlEntitySalesLine addLine()

addLine() メソッドは、行オブジェクト (この例では salesLine) を行のコレクションに追加して、アプリケーションプログラミングインターフェイス (API) の Fluent を維持するために親エンティティ (この例では SalesOrder) を返します。新しい行を作成するには、newLine() メソッドを作成します。

コンポーネント追加の命名規則

コンポーネントを追加するメソッドは、ボタンの UI 名を使う必要があります。

例

salesLine = salesOrder.addLine();

コンポーネントコレクション

クエリメソッドを使用してコンポーネントを検索できます。

コンポーネントコレクションの命名規則

コンポーネントコレクションにアクセスするメソッドは、ホスティングページのグリッドの UI 名を使用する必要があります。

クエリメソッド

エンティティのクエリメソッドを使用して、コンポーネントと関連エンティティを検索できます。

例

transferOrderLine = transferOrder.lines().withItem(item).single();

この例では、lines() は AtlQueryTransferOrderLines クエリを返すクエリメソッドです。このクエリは既にフィルターされてるため、lines() メソッドが呼び出された移動オーダーの移動オーダー行のみを返します。

名前付け規則

可能な限り UI 名を使用してください。 UI 名がテスト自動化に使用するのに長すぎる場合は、省略形を使用できます。

例

public AtlQueryWHSLoadLines lines()
{
    return new AtlQueryWHSLoadLines().forLoadId(this.parmLoadId());
}

追加リソース

承認テストライブラリのクエリ

次の方法で共有

承認テスト ライブラリのエンティティ

名前付け規則

例

プロパティ メソッド

プリミティブ型のプロパティ

例

エンティティ参照

エンティティ参照メソッドの命名規則

レコード参照

レコード参照の命名規則

ID 参照

ID 参照の命名規則

ID 参照メソッドの契約

Fluent セッター メソッド

宣言の例

コードの例

名前付け規則

アクション メソッド

単純なアクション メソッド

名前付け規則

例

コマンド オブジェクト初期化子

名前付け規則

例

アクション エンティティ

名前付け規則

例

クラスの命名規則

例

コンポーネントの追加

例

コンポーネント追加の命名規則

例

コンポーネント コレクション

コンポーネント コレクションの命名規則

クエリ メソッド

例

名前付け規則

例

追加リソース

フィードバック

その他のリソース

承認テストライブラリのエンティティ

プロパティメソッド

Fluent セッターメソッド

アクションメソッド

単純なアクションメソッド

コマンドオブジェクト初期化子

アクションエンティティ

コンポーネントコレクション

コンポーネントコレクションの命名規則

クエリメソッド