WorkManagerオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.22 |
since | 8.0.0 |
非同期タスクを扱うオブジェクトです。
非同期タスクの登録や操作を行う場合に使用します。
コンストラクタの概要
WorkManager () WorkManagerオブジェクトを生成します。 |
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | addParallelizedTask (String jsPath , Object parameter , Boolean [keepTaskMessageOnError] ) 並列処理キューにメッセージを追加します。 |
ResultObject | addSerializedTaskQueue (String queueId , Boolean active ) キューIDで指定された直列タスクキューを追加します。 |
ResultObject | addSerializedTask (String queueId , String jsPath , Object parameter , Boolean stopQueueProcessingIfError , Boolean [keepTaskMessageOnError] ) 直列処理キューにメッセージを追加します。 |
ResultObject | getAllSerializedTaskQueuesStatus () すべて直列キューの状況を取得します。 |
ResultObject | getParallelizedErroredTaskInfo (String sort , String order , Number startIndex , Number length ) 並列キューのエラー終了のタスクを取得します。 |
ResultObject | getParallelizedRunningTaskInfo (String sort , String order , Number startIndex , Number length ) 並列キューの処理中のタスクを取得します。 |
ResultObject | getParallelizedTaskQueuesStatus () 並列キューの状況を取得します。 |
ResultObject | getParallelizedWaitingTaskInfo (String sort , String order , Number startIndex , Number length ) 並列キューの待機中のタスクを取得します。 |
ResultObject | getRegisteredInfo () キューの状態を取得します。 |
ResultObject | getSerializedErroredTaskInfo (String queueId , String sort , String order , Number startIndex , Number length ) 指定されたキューIDの直列キューのエラー終了のタスクを取得します。 |
ResultObject | getSerializedTaskInfo (String queueId , String sort , String order , Number startIndex , Number length ) 指定されたキューIDの直列キューの待機中のタスクを取得します。 |
ResultObject | getSerializedTaskQueuesStatusById (String queueId ) 指定されたキューIDのキューの状態を取得します。 |
ResultObject | getTaskStatusById (String messageId ) タスクの状況を取得します。 |
ResultObject | reentryErroredTask (String messageId , Boolean usePreviousContext , Object [parameter] ) 指定されたエラー終了タスクを再登録(キューにメッセージを追加)します。 |
ResultObject | releaseRunningParallelizedTask (String messageId , Boolean reentry , Boolean stop ) メッセージIDで指定された並列タスクに対して終了を通知します。 |
ResultObject | releaseRunningSerializedTask (String messageId , Boolean reentry , Boolean stop ) メッセージIDで指定された直列タスクに対して終了を通知します。 |
ResultObject | removeErroredTask (String messageId ) 指定されたエラー終了タスクを削除します。 |
ResultObject | removeParallelizedTask (String messageId ) 指定された並列タスクを削除します。 |
ResultObject | removeSerializedTaskQueue (String queueId ) キューIDで指定された直列タスクキューを削除します。 |
ResultObject | removeSerializedTask (String messageId ) 指定された直列タスクを削除します。 |
ResultObject | setParallelizedTaskQueueActive (Boolean active ) 並列タスクの処理実行を開始または停止します。 |
ResultObject | setSerializedTaskQueueActive (String queueId , Boolean active ) キューIDで指定された直列タスクの処理実行を開始または停止します。 |
ResultObject | stopRunningParallelizedTask (String messageId , Boolean reentry , Boolean stop ) 非推奨メッセージIDで指定された現在処理中の並列タスクを強制停止します。
このメソッドの代わりにreleaseRunningParallelizedTaskを利用するようにしてください。
|
ResultObject | stopRunningSerializedTask (String messageId , Boolean reentry , Boolean stop ) 非推奨メッセージIDで指定された現在処理中の直列タスクを強制停止します。
このメソッドの代わりにreleaseRunningSerializedTaskを利用するようにしてください。
|
コンストラクタの詳細
WorkManager ()
WorkManagerオブジェクトを生成します。
|
メソッドの詳細
ResultObject addParallelizedTask (String jsPath , Object parameter , Boolean [keepTaskMessageOnError] )
並列処理キューにメッセージを追加します。
parameterで指定できる値は以下の条件を満たす連想配列である必要があります。
パラメータ
返却値
|
ResultObject addSerializedTaskQueue (String queueId , Boolean active )
キューIDで指定された直列タスクキューを追加します。
キューIDで指定された直列タスクが既に存在する場合は何もしません。この場合、戻り値としてfalseが返されます。
パラメータ
返却値
|
ResultObject addSerializedTask (String queueId , String jsPath , Object parameter , Boolean stopQueueProcessingIfError , Boolean [keepTaskMessageOnError] )
直列処理キューにメッセージを追加します。
stopQueueProcessingIfErrorとkeepTaskMessageOnErrorいずれもtrueが指定されている状態でタスクの実行時に例外が発生した場合は、stopQueueProcessingIfErrorの指定が優先されます。
パラメータ
返却値
|
ResultObject getAllSerializedTaskQueuesStatus ()
すべて直列キューの状況を取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
返却値
|
ResultObject getParallelizedErroredTaskInfo (String sort , String order , Number startIndex , Number length )
並列キューのエラー終了のタスクを取得します。
addParallelizedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみ抽出されます。 このメソッドは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
パラメータ
返却値
|
ResultObject getParallelizedRunningTaskInfo (String sort , String order , Number startIndex , Number length )
並列キューの処理中のタスクを取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
パラメータ
返却値
|
ResultObject getParallelizedTaskQueuesStatus ()
並列キューの状況を取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
返却値
|
ResultObject getParallelizedWaitingTaskInfo (String sort , String order , Number startIndex , Number length )
並列キューの待機中のタスクを取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
パラメータ
返却値
|
ResultObject getRegisteredInfo ()
キューの状態を取得します。
返却値
|
ResultObject getSerializedErroredTaskInfo (String queueId , String sort , String order , Number startIndex , Number length )
指定されたキューIDの直列キューのエラー終了のタスクを取得します。
addSerializedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみ抽出されます。 このメソッドは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
パラメータ
返却値
|
ResultObject getSerializedTaskInfo (String queueId , String sort , String order , Number startIndex , Number length )
指定されたキューIDの直列キューの待機中のタスクを取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
パラメータ
返却値
|
ResultObject getSerializedTaskQueuesStatusById (String queueId )
指定されたキューIDのキューの状態を取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
パラメータ
返却値
|
ResultObject getTaskStatusById (String messageId )
タスクの状況を取得します。
このメソッドは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
パラメータ
返却値
|
ResultObject reentryErroredTask (String messageId , Boolean usePreviousContext , Object [parameter] )
指定されたエラー終了タスクを再登録(キューにメッセージを追加)します。
addSerializedTask# およびaddParallelizedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみ対象です。 parameterが未指定またはnullを指定した場合は、前回実行時のパラメータ(jsのパスも含む)を再利用します。 このメソッドは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
パラメータ
返却値
|
ResultObject releaseRunningParallelizedTask (String messageId , Boolean reentry , Boolean stop )
メッセージIDで指定された並列タスクに対して終了を通知します。
終了を通知された並列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。 このメソッドを呼び出す際、並列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。
パラメータ
返却値
|
ResultObject releaseRunningSerializedTask (String messageId , Boolean reentry , Boolean stop )
メッセージIDで指定された直列タスクに対して終了を通知します。
終了を通知された直列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。 このメソッドを呼び出す際、直列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。
パラメータ
返却値
|
ResultObject removeErroredTask (String messageId )
指定されたエラー終了タスクを削除します。
addSerializedTask# およびaddParallelizedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみ対象です。 このメソッドは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
パラメータ
返却値
|
ResultObject removeParallelizedTask (String messageId )
指定された並列タスクを削除します。
パラメータ
返却値
|
ResultObject removeSerializedTaskQueue (String queueId )
キューIDで指定された直列タスクキューを削除します。
キューIDで指定された直列タスクが存在しない場合は何もしません。この場合、戻り値としてfalseが返されます。
パラメータ
返却値
|
ResultObject removeSerializedTask (String messageId )
指定された直列タスクを削除します。
パラメータ
返却値
|
ResultObject setParallelizedTaskQueueActive (Boolean active )
並列タスクの処理実行を開始または停止します。
パラメータ
返却値
|
ResultObject setSerializedTaskQueueActive (String queueId , Boolean active )
キューIDで指定された直列タスクの処理実行を開始または停止します。
パラメータ
返却値
|
ResultObject stopRunningParallelizedTask (String messageId , Boolean reentry , Boolean stop )
非推奨
このメソッドの代わりにreleaseRunningParallelizedTaskを利用するようにしてください。
メッセージIDで指定された現在処理中の並列タスクを強制停止します。
停止された並列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。 このメソッドを呼び出す際、並列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。
パラメータ
返却値
|
ResultObject stopRunningSerializedTask (String messageId , Boolean reentry , Boolean stop )
非推奨
このメソッドの代わりにreleaseRunningSerializedTaskを利用するようにしてください。
メッセージIDで指定された現在処理中の直列タスクを強制停止します。
停止された直列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。 このメソッドを呼び出す際、直列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。
パラメータ
返却値
|