System クラス

署名

public static Void abortJob(String jobId)

パラメータ

jobId

型: String

jobId は、AsyncApexJob または CronTrigger のいずれかに関連付けられた ID です。

戻り値

型: Void

使用方法

次のメソッドは、abortJob に渡すことができるジョブ ID を返します。

• System.schedule メソッド — スケジュール済みのジョブに関連付けられている CronTrigger オブジェクト ID を文字列として返します。
• SchedulableContext.getTriggerId メソッド — スケジュール済みのジョブに関連付けられている CronTrigger オブジェクト ID を文字列として返します。
• getJobId メソッド — 一括処理ジョブに関連付けられている AsyncApexJob オブジェクト ID を文字列として返します。
• Apex の一括処理の使用Database.executeBatch メソッド — 一括処理ジョブに関連付けられている AsyncApexJob オブジェクト ID を文字列として返します。

署名

public static Void assert(Boolean condition, Object msg)

パラメータ

condition

型: Boolean

msg

型: Object

(省略可能) エラーメッセージの一部として返されるカスタムメッセージ。

戻り値

型: Void

使用方法

アサーションの失敗は、例外としてログに記録されていても、try/catch ブロックを使用して捕捉することはできません。

署名

public static Void assertEquals(Object expected, Object actual, Object msg)

パラメータ

expected

型: Object

期待値を指定します。

actual

型: Object

実際の値を指定します。

msg

型: Object

(省略可能) エラーメッセージの一部として返されるカスタムメッセージ。

戻り値

型: Void

使用方法

アサーションの失敗は、例外としてログに記録されていても、try/catch ブロックを使用して捕捉することはできません。

署名

public static Void assertNotEquals(Object expected, Object actual, Object msg)

パラメータ

expected

型: Object

期待値を指定します。

actual

型: Object

実際の値を指定します。

msg

型: Object

(省略可能) エラーメッセージの一部として返されるカスタムメッセージ。

戻り値

型: Void

使用方法

アサーションの失敗は、例外としてログに記録されていても、try/catch ブロックを使用して捕捉することはできません。

署名

public static System.PageReference currentPageReference()

戻り値

型: System.PageReference

使用方法

詳細は、「PageReference クラス」を参照してください。

署名

public static Long currentTimeMillis()

戻り値

型: Long

署名

public static Void debug(Object msg)

パラメータ

msg

型: Object

戻り値

型: Void

使用方法

msg 引数が string でない場合、debug メソッドは String.valueOf をコールして引数を string に変換します。String.valueOf メソッドは、その引数に対する toString メソッド (利用可能な場合)、または引数がユーザ定義型の場合は上書きされた toString をコールします。それ以外の、toString メソッドが利用できない場合は引数の文字列表現を返します。

Apex コードのログレベルが DEBUG 以上に設定されていると、この debug ステートメントのメッセージはデバッグログに書き込まれます。

ログレベルについての詳細は、Salesforce オンラインヘルプの「デバッグログレベル」を参照してください。

署名

public static Void debug(LoggingLevel logLevel, Object msg)

パラメータ

logLevel

型: System.LoggingLevel

このメソッドに設定するログレベルです。

msg

型: Object

実行デバッグログに string 形式で書き込むメッセージまたはオブジェクトです。

戻り値

型: Void

使用方法

msg 引数が string でない場合、debug メソッドは String.valueOf をコールして引数を string に変換します。String.valueOf メソッドは、その引数に対する toString メソッド (利用可能な場合)、または引数がユーザ定義型の場合は上書きされた toString をコールします。それ以外の、toString メソッドが利用できない場合は引数の文字列表現を返します。

システムの Logging Level

loggingLevel 列挙を使用して、debug メソッドのログレベルを指定します。

ログレベルは累積です。たとえば、Apex コードに最も低いレベル ERROR が指定されている場合、ログレベルが ERROR である debug メソッドのみが記録されます。次のログレベル WARN が指定されている場合、デバッグログには ERROR または WARN として指定されている debug メソッドが含まれます。

次の例では、ログレベルが ERROR で debug メソッドのレベルが INFO であるため、文字列 MsgTxt はデバッグログには書き込まれません。

1System.LoggingLevel level = LoggingLevel.ERROR;
2
3System.debug(logginglevel.INFO, 'MsgTxt');

ログレベルについての詳細は、Salesforce オンラインヘルプの「デバッグログレベル」を参照してください。

署名

public static ID enqueueJob(Object queueableObj)

パラメータ

queueableObj

型: Object

Queueable インターフェースを実装するクラスのインスタンス。

戻り値

型: ID

AsyncApexJob レコードの ID に対応するジョブ ID。

使用方法

非同期実行のジョブを追加するには、次のように、実行に使用する Queueable インターフェースのクラス実装のインスタンスを渡して、System.enqueueJob をコールします。

1ID jobID = System.enqueueJob(new MyQueueableClass());

制限に関する情報など、Queueable Apex についての詳細は、「キュー可能 Apex」を参照してください。

署名

public static Boolean equals(Object obj1, Object obj2)

パラメータ

obj1

型: Object

比較されるオブジェクト。

obj2

型: Object

最初の引数と比較するオブジェクト。

戻り値

型: Boolean

使用方法

obj1 と obj2 は任意の種別にすることができます。これらのパラメータには、値やオブジェクト参照 (sObject、ユーザ定義型など) を指定できます。

System.equals の比較ルールは、== 演算子の比較ルールと同じです。たとえば、文字列の比較では大文字と小文字を区別しません。比較ルールについての詳細は、「== 演算子」を参照してください。

署名

public static System.ApplicationReadWriteMode getApplicationReadWriteMode()

戻り値

型: System.ApplicationReadWriteMode

System.ApplicationReadWriteMode 列挙の使用

Salesforce のアップグレードおよびダウンタイム中にアプリケーションが参照のみモードであるかどうかをプログラムで判断するには、getApplicationReadWriteMode によって返される System.ApplicationReadWriteMode enum を使用します。

1public class myClass {
2  public static void execute() {
3    ApplicationReadWriteMode mode = System.getApplicationReadWriteMode();
4
5    if (mode == ApplicationReadWriteMode.READ_ONLY) {
6      // Do nothing. If DML operaton is attempted in readonly mode, 
7      // InvalidReadOnlyUserDmlException will be thrown.  
8    } else if (mode == ApplicationReadWriteMode.DEFAULT) {
9      Account account = new Account(name = 'my account');
10      insert account;
11    }
12  }
13}

署名

public String getQuiddityShortCode(System.Quiddity QuiddityValue)

パラメータ

QuiddityValue

型: System.Quiddity

関連付けられたショートコードがある Quiddity 列挙値。このショートコードはイベント監視ログで使用されます。詳細は、「Apex 実行イベント種別」を参照してください。

戻り値

型: String

署名

public static Integer hashCode(Object obj)

パラメータ

obj

型: Object

ハッシュコードを取得するオブジェクト。このパラメータは、値やオブジェクト参照 (sObject、ユーザ定義型) など任意の型にすることができます。

戻り値

型: Integer

バージョン管理動作の変更

API バージョン 51.0 以降、hashCode() メソッドは、同じ ID 値では同じ hashCode を返します。API バージョン 50.0 以前では、同じ ID 値でも、異なる hashCode 値が生成されることがありました。

署名

public static Boolean isBatch()

戻り値

型: Boolean

使用方法

Apex 一括処理ジョブは future メソッドを呼び出すことはできません。future メソッドを呼び出す前に、isBatch() を使用して実行コードが Apex 一括処理ジョブであるかどうかを確認します。

署名

public static Boolean isFuture()

戻り値

型: Boolean

使用方法

future メソッドは、別の future メソッドから呼び出せないため、future メソッドの呼び出し前にこのメソッドを使用して、現在のコードが future メソッドのコンテキスト内で実行されているかどうかを確認します。

署名

public static Boolean isQueueable()

戻り値

型: Boolean

使用方法

1public class SimpleQueueable implements Queueable {
2
3    String name;
4
5    public SimpleQueueable(String name) {
6        this.name = name;
7        System.assert(!System.isQueueable());    //Should return false
8    }
9
10    public void execute(QueueableContext ctx) {
11        Account testAccount  = new Account();
12        testAccount.name = 'testAcc';
13        insert(testAccount);
14        System.assert(System.isQueueable());    //Should return true
15    }
16}

1global class ComplexBatch implements Database.Batchable<SObject> {
2    
3    global Database.QueryLocator start(Database.BatchableContext info) {
4        System.assert(!System.isQueueable());    //Should return false
5        return Database.getQueryLocator([SELECT Id, Name FROM Account LIMIT 1]);
6    }
7    
8    global void execute(Database.BatchableContext info, SObject[] scope) {
9        System.assert(!System.isQueueable());    //Should return false
10        System.enqueueJob(new SimpleQueueable('CallingFromComplexBatch'));
11        System.assert(!System.isQueueable());    //Should return false
12    }
13    
14    global void finish(Database.BatchableContext info) {
15        System.assert(!System.isQueueable());    //Should return false
16    }
17}

署名

public static Boolean isRunningElasticCompute()

戻り値

型: Boolean

署名

public static Boolean isScheduled()

戻り値

型: Boolean

署名

public static Void movePassword(ID targetUserId, ID sourceUserId)

パラメータ

targetUserId

型: ID

パスワードの移動先のユーザ。

sourceUserId

型: ID

パスワードの移動元のユーザ。

戻り値

型: Void

使用方法

外部ユーザをアクセス権の制限が緩いユーザに変換する場合などにパスワードを移動すると、ユーザを別の種別のユーザに簡単に変換できます。movePassword メソッドにアクセスする必要がある場合は、Salesforce にお問い合わせください。

署名

public static Datetime now()

戻り値

型: Datetime

署名

public static List<Id> process(List<Id> workItemIds, String action, String comments, String nextApprover)

パラメータ

workItemIds

型: List<Id>

action

型: String

comments

型: String

nextApprover

型: String

戻り値

型: List<Id>

署名

public static Integer purgeOldAsyncJobs(Date dt)

パラメータ

dt

型: Date

どの日付以前の古いレコードを削除するのか、日付を指定します。日付の比較は、AsyncApexJob の CompletedDate 項目 (GMT タイムゾーン) に基づいて比較されます。

戻り値

型: Integer

使用方法

Apex 非同期ジョブレコードは、AsyncApexJob のレコードです。

システムは、実行を終了した、8 日以上前のジョブについて非同期ジョブレコードをクリーンアップします。このメソッドを使用し、より多くのレコードをクリーンアップすることで、AsyncApexJob のサイズをさらに小さくすることができます。

このメソッドの各実行は、DML ステートメントのガバナ制限に単一行として含まれます。

例

1Integer count = System.purgeOldAsyncJobs
2   (Date.today());
3System.debug('Deleted ' + 
4   count + ' old jobs.');

署名

public static System.Version requestVersion()

戻り値

型: System.Version

使用方法

このメソッドによって、コール元のコードがパッケージを参照するときに用いる、パッケージのインストール済みインスタンスのバージョンを特定できます。コール元のコードが保持するバージョンに基づいて、パッケージコードの動作をカスタマイズできます。

未管理パッケージの場合、requestVersion メソッドはサポートされません。未管理パッケージからコールする場合、例外が発生します。

署名

public static System.ResetPasswordResult resetPassword(ID userId, Boolean sendUserEmail)

パラメータ

userId

型: ID

sendUserEmail

型: Boolean

戻り値

型: System.ResetPasswordResult

使用方法

ユーザが新しいパスワードでログインすると、新しいパスワードを入力してセキュリティに関する質問および回答を選択するように求められます。sendUserEmail に true を指定すると、パスワードがリセットされたことをユーザに通知するメールが送信されます。このメールには、新しいパスワードを使用して Salesforce にサインオンするためのリンクが含まれます。ユーザのログイン時に新しいパスワードの入力を求めない場合は、setPassword(userId, password) を使用します。

署名

public static System.ResetPasswordResult resetPasswordWithEmailTemplate(Id userId, Boolean sendUserEmail, String emailTemplateName)

パラメータ

userId

型: Id

パスワードがリセットされたユーザの ID。

sendUserEmail

型: Boolean

emailTemplateName

型: String

メールテンプレートの名前。

戻り値

型: System.ResetPasswordResult

使用方法

sendUserEmail に true を指定する場合、パスワードがリセットされたことをユーザに通知するメールテンプレートを指定します。メール内の新しいパスワードでユーザがログインすると、新しいパスワードを入力するように求められます。このメールには、新しいパスワードを使用して Salesforce にサインオンするためのリンクが含まれます。ユーザのログイン時に新しいパスワードの入力を求めない場合は、setPassword(userId, password) を使用します。

署名

public static Void runAs(System.Version version)

パラメータ

version

型: System.Version

戻り値

型: Void

使用方法

パッケージ開発者は、コードをアップグレードしながら、以前のパッケージバージョンのクラスおよびトリガの既存の動作を引き続きサポートするために、Version メソッドを使用できます。Apex クラスおよびトリガは、クラスまたはトリガが参照するインストール済みの各管理パッケージのバージョン設定で保存されます。

このメソッドを使用して、AppExchange にアップロードする異なるパッケージバージョンのコンポーネントの動作をテストします。このメソッドは、異なるパッケージバージョンの動作をテストできるように、テストメソッドのメジャーバージョン番号とマイナーバージョン番号の 2 つで構成されるバージョン番号を効率的に設定します。

テストメソッドでは runAs のみ使用できます。トランザクションで、このメソッドに対するコール数の制限はありません。このメソッドの使用例は、「パッケージバージョンの動作のテスト」を参照してください。

署名

public static Void runAs(User userSObject)

パラメータ

userSObject

型: User

戻り値

型: Void

使用方法

指定されたユーザのレコード共有のすべてが、runAs の実行時に強制されます。テストメソッドでは runAs のみ使用できます。詳細は、「runAs() メソッドの使用」を参照してください。

runAs メソッドは、パラメータとして渡されたユーザがインスタンス化済みでまだ挿入されていない場合は、暗黙的に挿入します。

DML 操作を runAs ブロックで囲むことで、runAs を使用して混合 DML 操作をテストで実行することもできます。この方法では、設定オブジェクトを他の sObject と一緒に挿入または更新しようとすると返される混合 DML エラーを回避できます。「DML 操作で同時に使用できない sObject」を参照してください。

署名

public static String schedule(String jobName, String cronExpression, Object schedulableClass)

パラメータ

jobName

型: String

cronExpression

型: String

schedulableClass

型: Object

戻り値

型: String

スケジュール済みジョブ ID (CronTrigger ID) を返します。

使用方法

クラスをトリガからスケジュールする場合は、細心の注意を払ってください。制限を超えるスケジュールクラスをトリガで追加しないようにする必要があります。特に、API の一括更新、インポートウィザード、ユーザインターフェースを使用したレコードの一括変更、および複数のレコードを一度に更新するすべての処理については十分に考慮してください。abortJob メソッドを使用して、スケジュールされた後にジョブを停止します。

System.Schedule メソッドの使用

1Seconds Minutes Hours Day_of_month Month Day_of_week Optional_year

式の値は次のとおりです。

次に、式の使用方法の例を示します。

次の例では、クラス proschedule によって Schedulable インターフェースが実装されます。このクラスは、2 月 13 日の午前 8 時に実行するようにスケジュールされています。

1proschedule p = new proschedule();
2        String sch = '0 0 8 13 2 ?';
3        system.schedule('One Time Pro', sch, p);

署名

public static String scheduleBatch(Database.Batchable batchable, String jobName, Integer minutesFromNow)

パラメータ

batchable

型: Database.Batchable

Database.Batchable インターフェースを実装するクラスのインスタンス。

jobName

型: String

このメソッドが開始するジョブの名前。

minutesFromNow

型: Integer

ジョブを実行開始するまでの分単位の期間。この引数は 0 よりも大きい値にする必要があります。

戻り値

型: String

スケジュール済みジョブ ID (CronTrigger ID)。

使用方法

「Apex の一括処理の使用」の例を参照してください。

署名

public static String scheduleBatch(Database.Batchable batchable, String jobName, Integer minutesFromNow, Integer scopeSize)

パラメータ

batchable

型: Database.Batchable

Database.Batchable インターフェースを実装する一括処理クラス。

jobName

型: String

このメソッドが開始するジョブの名前。

minutesFromNow

型: Integer

ジョブを実行開始するまでの分単位の期間。

scopeSize

型: Integer

一括処理 execute メソッドに渡すレコードの数です。

戻り値

型: String

使用方法

「System.scheduleBatch メソッドの使用」の例を参照してください。

署名

public static Void setPassword(ID userId, String password)

パラメータ

userId

型: ID

password

型: String

戻り値

型: Void

使用方法

このパスワードでユーザがログインすると、新しいパスワードを作成するように求められません。ユーザがリセットプロセスを行い、独自のパスワードを作成するようにする場合は、resetPassword(userId, sendUserEmail) を使用します。

署名

public static List<ID> submit(List<ID> workItemIds, String comments, String nextApprover)

パラメータ

workItemIds

型: List<ID>

comments

型: String

nextApprover

型: String

戻り値

型: List<ID>

使用方法

申請および評価の拡張機能についての詳細は、「ProcessSubmitRequest クラス」クラスを参照してください。

署名

public static Date today()

戻り値

型: Date