Apex addErrorでsObject の項目に動的にエラーを追加する

2024年2月12日

環境
Salesforce

構文
public void addError(String fieldName, String errorMsg, Boolean escape)
指定された項目名に関連付けられた sObject の項目に動的にエラーを追加します。

パラメータについて
fieldName
型: String
sObject の項目名。

errorMsg
型: String
追加するエラーメッセージ。
escape

型: Boolean
カスタムエラーメッセージ内の HTML マークアップがエスケープされるか (true)、
否か (false) を示します。このパラメーターは Lightning Experience と Salesforce
モバイルアプリケーションの両方で無視され、HTML は常にエスケープされます。
escape パラメーターは Salesforce Classic でのみ適用されます。

使用例
エスケープ文字は、\n、<、>、&、"、\、\u2028、\u2029、\u00a9 です。
このため、HTML マークアップは表示されず、その代わりに、Salesforce
ユーザーインターフェースにテキストとして表示されます。
サンプルコード

// addError() メソッドを使用して、SObject フィールドにエラーを追加
Account acct = new Account(name = 'TestAccount');
acct.addError('name', 'error in name field', false);
// hasErrors() メソッドを使用してエラーが追加されたことを確認し、次に getErrors() メソッドを使用してエラーを検証
System.Assert(acct.hasErrors());
List<Database.Error> errors = acct.getErrors();
System.AssertEquals(1, errors.size());