gcss Apexインターフェース

このセクションでは、Apexインターフェースについて詳述しています。

Apexインターフェースの具体的な利用例はカスタムフィルターを追加するを参照してください。


IUserFilterProvider インターフェース

IUserFilterProviderインターフェースはRaySheetのユーザーフィルターを提供します。ユーザーはこのインターフェースを実装して、Apexのロジックを使用してカスタムフィルターを作成できます。

構文

global interface IUserFilterProvider {
  UserFilter getUserFilter(string objectName);
}

解説

指定されたSObjectのUserFilterオブジェクトを取得します。戻り値がnull場合は、このSObjectにユーザーフィルターが追加されないことを意味します。それ以外の場合、返されたユーザーフィルターはRaySheetの組み込みフィルターと組み合わせて使用されます。


IUserFilterProvider2 インターフェース

IUserFilterProvider2インターフェースはRaySheetのユーザーフィルターを提供します。ユーザーはこのインターフェースを実装して、Apexのロジックを使用してカスタムフィルターを作成できます。IUserFilterProviderインターフェースとはパラメーターを指定できる点が異なります。

構文

global interface IUserFilterProvider2 {
  UserFilter getUserFilter(string objectName, Map<String,Object> context);
}

解説

指定されたSObjectのUserFilterオブジェクトを取得します。戻り値がnull場合は、このSObjectにユーザーフィルターが追加されないことを意味します。それ以外の場合、返されたユーザーフィルターはRaySheetの組み込みフィルターと組み合わせて使用されます。


UserFilter クラス

RaySheetのユーザーフィルターを表します。ユーザーフィルターは、RaySheet組み込みフィルターと組み合わせて使用されます。

構文

global class UserFilter{
  public string whereClause;
  
  // WHERE句の変数。userArg1からuserArg10まで10個の変数を提供します。
  // たとえば、 "Id in:userArg1"のようになり、userArg1はId配列の値を持ちます。
  public object userArg1;
  public object userArg2;
  public object userArg3;
  public object userArg4;
  public object userArg5;
  public object userArg6;
  public object userArg7;
  public object userArg8;
  public object userArg9;
  public object userArg10;
}

解説

このWHERE句に検索条件を入れてフィルターを実装することができます。このWHERE句は、RaySheetのクエリ文字列に追加されます。WHERE句に構文エラーがある場合は、RaySheetはレコードのロード中にエラーを表示します。

SOQL構文のWHERE句については、条件式の構文 (WHERE 句)を参照してください。

WHERE句では変数を使用することができます。詳細は、SOQL クエリおよび SOSL クエリでの Apex 変数の使用を参照してください。

Copyright © 2024 MESCIUS inc. All rights reserved.