EventHandlerResult を使用して応答

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

いくつかのデリゲートメソッドは、デリゲートハンドラーメソッドのサブスクライブから応答を要求できるように実装されます。デリゲート呼び出しロジックは、応答の受信後に実行を継続するときに潜在的なサブスクライバからの応答を使用します。これらのデリゲートメソッドは通常、EventHandlerResult パラメーターを最後のパラメーターとして持つシグネチャを持っています。ただし、EventHandlerAcceptResult および EventHandlerRejectResult タイプのサポートが原因で、パラメーターは IEventHandlerResult インターフェイスを実装する任意のタイプになります。

一般に、デリゲートハンドラーメソッドに実装されているロジックには、サブスクライブしているロジックが応答の提供を担当していることを検証する条件を含める必要があります。結果のフォームに応答を提供するロジックも含める必要があります。
デリゲートハンドラーメソッドが EventHandlerResult オブジェクトパラメーターへの応答を提供する必要があるとき、サブスクライブするロジックには結果の計算または取得のためのロジックも含まれている場合があります。
条件と応答ロジックが実装されると、条件が true と評価されたときのみ、結果の計算を実行する必要があります。
すべてのサブスクライブしているデリゲートハンドラーメソッドはデリゲートが呼び出されたときに実行されます。したがって、メソッドがレスポンスの提供を担当していない場合は、メソッドを実行する間接費ができるだけ低いことを確認する必要があります。したがって、デリゲートハンドラーメソッドが結果を提供する責任を負わない場合、できるだけ早く条件が false に評価されていることを確認してください。

例

次の例は、switch ステートメントの形式の条件を持つデリゲートハンドラーを示しています。デリゲートハンドラーには結果のフォームに応答を提供するロジックがあります。応答するロジックは、条件が true に評価された場合にのみ実行されます。

[SubscribesTo(tableStr(InventWarehouseEntity), delegateStr(InventWarehouseEntity, validateWarehouseTypeDelegate))]
public static void validateWarehouseTypeIsSupportedStandardDelegateHandler(InventLocationType _inventLocationType, EventHandlerResult _result)
{
    switch (_inventLocationType)
    {
        case InventLocationType::Standard:
        case InventLocationType::Quarantine:
        case InventLocationType::Transit:
            _result.result(true);
            break;
    }
}

デリゲートメソッドが、EventHandlerAcceptResult または EventHandlerRejectResult オブジェクトパラメーターを使用して、応答を要求するとき、サブスクライバーは、承認または否認でのみ応答することを想定します。サブスクライブロジックは、メッセージを Infolog に追加することもできます。

次の例は、前の例に似ています。ただし、デリゲートメソッドは、EventHandlerAcceptResult オブジェクトの使用によりおよび受け入れメソッドを呼び出すことにより、応答を要求するようになります。

[SubscribesTo(tableStr(InventWarehouseEntity), delegateStr(InventWarehouseEntity, validateWarehouseTypeDelegate))]
public static void validateWarehouseTypeIsSupportedStandardDelegateHandler(InventLocationType _inventLocationType, EventHandlerAcceptResult _result)
{
    switch (_inventLocationType)
    {
        case InventLocationType::Standard:
        case InventLocationType::Quarantine:
        case InventLocationType::Transit:
            _result.accept();
            break;
    }
}

次の例では、EventHandlerRejectResult オブジェクトを使用して応答するデリゲートハンドラーメソッドを示しています。 EventHandlerRejectResult オブジェクトを使用して応答するには、reject メソッドまたは checkFailed 拡張メソッドを呼び出します。 checkFailed メソッドを使用する場合は、情報ログに警告メッセージを追加できます。内部的には、checkFailed メソッドは reject メソッドを呼び出します。

[SubscribesTo(classStr(ProdTableType), delegateStr(ProdTableType, validateWriteProdTableInventRefTypeDelegate))]
public static void validateWriteProdTableInventRefTypeDelegateHandler(ProdTable _prodTable, EventHandlerRejectResult _result)
{
    if (_prodTable.InventRefType == InventRefType::ProdLine)
    {
        if (! _prodTable.InventRefId || !_prodTable.InventRefTransId)
        {
            _result.checkFailed("@SYS19558");
        }
        ProdBOM prodBOM;
        select prodBOM
            where prodBOM.InventTransId  == _prodTable.InventRefTransId;
        if (! _prodTable.checkRefProdBOM(prodBOM))
        {
            _result.reject();
        }
    }
}

ガイドライン

前述の実例に加えて、次の一般的なガイドラインが適用されます。

サブスクライブしているロジックが応答を担当する場合にのみ対応します。デリゲートハンドラーメソッドは、特定の条件が満たされたときに応答を提供するために実装されました。したがって、サブスクライブしているロジックは、特定の条件が満たされた場合に結果を提供する必要があります。サブスクライブしているロジックが応答する前に、結果オブジェクトパラメーターは既に結果が含まれているかどうかを評価することができません。たとえば、デリゲートハンドラーメソッドは、次の例にあるロジックに似たロジックを含めないようにする必要があります。このロジックは、メソッド実行時に EventHandlerResult オブジェクトパラメーターに結果がすでに含まれているかどうかを評価します。

警告

この例は、書くべきではないコードの例です。
```
[SubscribesTo(tableStr(InventWarehouseEntity), delegateStr(InventWarehouseEntity, validateWarehouseTypeDelegate))]
  public static void validateWarehouseTypeIsSupportedStandardDelegateHandler(InventLocationType _inventLocationType, EventHandlerResult _result)
  {
      // this if statement is an example of the bad practice.
      if (_result.hasResult())
      {
           return;
      }
      switch (_inventLocationType)
      {
          case InventLocationType::Standard:
          case InventLocationType::Quarantine:
          case InventLocationType::Transit:
               _result.result(true);
              break;
      }
  }
```
他のサブスクライバーの代理として応答を提供しないでください。デリゲートハンドラーメソッドが応答を提供する責任を負わない場合、メソッドは応答を提供できません。条件が満たされていないときに、メソッドが応答を提供する場合は、他のサブスクライバーに代わって応答を提供しています。要求元のロジックは、サブスクライバーが応答していない状況を処理する責任を負わなければなりません。デリゲートハンドラーメソッドは、次の例にあるロジックに似たロジックを含めないようにする必要があります。このロジックは、条件が false と評価されたときに結果を提供します。

警告

この例は、書くべきではないコードの例です。
```
  [SubscribesTo(tableStr(InventWarehouseEntity), delegateStr(InventWarehouseEntity, validateWarehouseTypeDelegate))]
  public static void validateWarehouseTypeIsSupportedStandardDelegateHandler(InventLocationType _inventLocationType, EventHandlerResult _result)
  {
      switch (_inventLocationType)
      {
          case InventLocationType::Standard:
          case InventLocationType::Quarantine:
          case InventLocationType::Transit:
              _result.result(true);
              break;
  	    // this default block is an example of the bad practice
          default:
              _result.result(false);
              break;
      }
  }
```

Share via

EventHandlerResult を使用して応答

例

ガイドライン

その他のリソース