コンストラクタの概要

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で指定できる値は以下の条件を満たす連想配列である必要があります。

  • keyは文字列および整数のみ指定できます。整数を指定した場合、文字列として扱われます。
  • keyにnullを指定することはできません。
  • valueは以下のいずれかを使用できます。
    • Boolean
    • 数値型
    • 文字列
    • 連想配列
      • パラメータ設定時のkey/valueと同じルールが再帰的に適用されます。
      • key/valueの情報のみ保持されます。その他の情報(順序等)は保存されません。
    • 配列
      • パラメータ設定時のvalueと同じルールが再帰的に適用されます。
      • 配列に設定された内容および順序は保持されます。

パラメータ
jsPath : String
並列タスク処理jsのパス
parameter : Object
パラメータ
[keepTaskMessageOnError] : Boolean
  • true: 指定したタスクの実行時に例外が発生した場合、タスクメッセージを削除せずに残す
  • false: 指定したタスクの実行時に例外が発生した場合でもタスクメッセージを削除する
  • 指定されなかった場合は、falseが使用されます。 このパラメータは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 実際に登録されたタスクメッセージID
  • 異常時:
    • error - true
    • data - なし
ResultObject addSerializedTaskQueue (String queueId, Boolean active)
キューIDで指定された直列タスクキューを追加します。

キューIDで指定された直列タスクが既に存在する場合は何もしません。この場合、戻り値としてfalseが返されます。

パラメータ
queueId : String
キューID
active : Boolean
  • true: 直列タスクの処理実行を開始できる状態で登録する
  • false: 直列タスクの処理実行を開始しない状態で登録する
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data -
      • true: キューを追加した場合
      • false: キューを追加しなかった場合
  • 異常時:
    • error - true
    • data - なし
ResultObject addSerializedTask (String queueId, String jsPath, Object parameter, Boolean stopQueueProcessingIfError, Boolean [keepTaskMessageOnError])
直列処理キューにメッセージを追加します。

stopQueueProcessingIfErrorとkeepTaskMessageOnErrorいずれもtrueが指定されている状態でタスクの実行時に例外が発生した場合は、stopQueueProcessingIfErrorの指定が優先されます。
そのため、当該タスクメッセージは直列処理キューに再登録され、エラー状態としては残りません。
明示的にエラー状態としてタスクメッセージを残す場合は、stopQueueProcessingIfErrorにfalse、keepTaskMessageOnErrorにtrueを指定します。

パラメータ
queueId : String
キューID
jsPath : String
タスクとして実行するJSのパス
parameter : Object
パラメータ
stopQueueProcessingIfError : Boolean
  • true: 指定したタスクの実行時に例外が発生した場合、同一キュー内の後続タスク処理を停止する
  • false: 指定したタスクの実行時に例外が発生した場合でも同一キュー内の後続タスク処理を続行する
[keepTaskMessageOnError] : Boolean
  • true: 指定したタスクの実行時に例外が発生した場合、タスクメッセージを削除せずに残す
  • false: 指定したタスクの実行時に例外が発生した場合でもタスクメッセージを削除する
  • 指定されなかった場合は、falseが使用されます。 このパラメータは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 実際に登録されたタスクメッセージID
  • 異常時:
    • error - true
    • data - なし
ResultObject getAllSerializedTaskQueuesStatus ()
すべて直列キューの状況を取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 現時点における登録済タスク情報のスナップショット
      • taskQueueStatus - 非同期処理の直列タスク情報の配列
        配列内の各要素は以下の構成を持つオブジェクトとなっています。
        • hasRunningTasksInfo - 処理中のタスク情報があるかどうかを示すフラグ
          • true: 処理中のタスクが存在する
          • false: 処理中のタスクが存在しない
        • isActive - キューの先頭のタスクを非同期処理割り当て候補とするかどうかを示すフラグ
          • true: キュー処理実行中
          • false: キュー処理停止中
        • waitingTasksCount - 待機中のタスク数
        • runningTasksCount - 処理中のタスク数
        • erroredTasksCount - エラー終了のタスク数
          addSerializedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみカウントされます。
          このパラメータは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
        • queueId - キューID
  • 異常時:
    • error - true
    • data - なし
ResultObject getParallelizedErroredTaskInfo (String sort, String order, Number startIndex, Number length)
並列キューのエラー終了のタスクを取得します。
addParallelizedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみ抽出されます。
このメソッドは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
パラメータ
sort : String
ソートカラム名
order : String
ソート順。昇順 asc/降順 desc
startIndex : Number
取得開始位置(1から)
length : Number
取得件数(負数場合、全件取得)
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 現時点における登録済タスク情報のスナップショット
      • parallelizedTaskInfo - 並列キューのエラー終了のタスク情報。
        • messageId - タスクメッセージID
        • sentTime - 送信日時
        • receivedTime - 受信日時
        • taskClassName - タスク実行クラス名
        • node - タスクが実行されたノードのノードID
        • parameter - タスクのパラメータ
        • acceptTime - タスクが非同期処理として割り当てられた日時
        • startTime - タスクが非同期処理として開始された日時(まだ開始されていない場合はnull)
      • count - エラー終了のタスク数
  • 異常時:
    • error - true
    • data - なし
ResultObject getParallelizedRunningTaskInfo (String sort, String order, Number startIndex, Number length)
並列キューの処理中のタスクを取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
パラメータ
sort : String
ソートカラム名
order : String
ソート順。昇順 asc/降順 desc
startIndex : Number
取得開始位置(1から)
length : Number
取得件数(負数場合、全件取得)
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 現時点における登録済タスク情報のスナップショット
      • parallelizedTaskInfo - 並列キューの処理中のタスク情報。
        • messageId - タスクメッセージID
        • sentTime - 送信日時
        • receivedTime - 受信日時
        • taskClassName - タスク実行クラス名
        • node - タスクが実行されているノードのノードID
        • parameter - タスクのパラメータ
          このパラメータは バージョン 8.0.17 より利用可能です。
        • acceptTime - タスクが非同期処理として割り当てられた日時
        • startTime - タスクが非同期処理として開始された日時(まだ開始されていない場合はnull)
      • count - 処理中のタスク数
  • 異常時:
    • error - true
    • data - なし
ResultObject getParallelizedTaskQueuesStatus ()
並列キューの状況を取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 現時点における登録済タスク情報のスナップショット
      • isActive - キューの先頭のタスクを非同期処理割り当て候補とするかどうかを示すフラグ
        • true: キュー処理実行中
        • false: キュー処理停止中
      • waitingTasksCount - 待機中のタスク数
      • runningTasksCount - 処理中のタスク数
      • erroredTasksCount - エラー終了のタスク数
        addParallelizedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみカウントされます。
        このパラメータは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
      • queueId - キューID
  • 異常時:
    • error - true
    • data - なし
ResultObject getParallelizedWaitingTaskInfo (String sort, String order, Number startIndex, Number length)
並列キューの待機中のタスクを取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
パラメータ
sort : String
ソートカラム名
order : String
ソート順。昇順 asc/降順 desc
startIndex : Number
取得開始位置(1から)
length : Number
取得件数(負数場合、全件取得)
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 現時点における登録済タスク情報のスナップショット
      • parallelizedTaskInfo - 並列キューの待機中のタスク情報。
        • messageId - タスクメッセージID
        • sentTime - 送信日時
        • receivedTime - 受信日時
        • taskClassName - タスク実行クラス名
        • parameter - タスクのパラメータ
          このパラメータは バージョン 8.0.17 より利用可能です。
      • count - 待機中のタスク数
  • 異常時:
    • error - true
    • data - なし
ResultObject getRegisteredInfo ()
キューの状態を取得します。
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 現時点における登録済タスク情報のスナップショット
      • parallelizedTasksInfo - 並列タスク情報。
        • isActive - キューの先頭のタスクを非同期処理割り当て候補とするかどうかを示すフラグ
          • true: キュー処理実行中
          • false: キュー処理停止中
        • waitingTasks - 非同期処理待機中の並列タスク情報の配列
          配列内の各要素は以下の構成を持つオブジェクトとなっています。
          • messageId - タスクメッセージID
          • sentTime - 送信日時
          • receivedTime - 受信日時
          • taskClassName - タスク実行クラス名
          • parameter - タスクのパラメータ
            このパラメータは バージョン 8.0.17 より利用可能です。
        • runningTasks - 非同期処理実行中の並列タスク情報の配列(順序は不定)
          • messageId - タスクメッセージID
          • sentTime - 送信日時
          • receivedTime - 受信日時
          • taskClassName - タスク実行クラス名
          • node - タスクが実行されているノードのノードID
          • parameter - タスクのパラメータ
            このパラメータは バージョン 8.0.17 より利用可能です。
          • acceptTime - タスクが非同期処理として割り当てられた日時
          • startTime - タスクが非同期処理として開始された日時(まだ開始されていない場合はnull)
        • erroredTasks - 非同期処理実行時にエラー終了した並列タスク情報の配列(順序は不定)
          addParallelizedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみ格納されます。
          配列内の各要素は以下の構成を持つオブジェクトとなっています。
          このパラメータは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
          • messageId - タスクメッセージID
          • sentTime - 送信日時
          • receivedTime - 受信日時
          • taskClassName - タスク実行クラス名
          • node - タスクが実行されているノードのノードID
          • parameter - タスクのパラメータ
          • acceptTime - タスクが非同期処理として割り当てられた日時
          • startTime - タスクが非同期処理として開始された日時(まだ開始されていない場合はnull)
      • serializedTasksInfo - 直列タスク情報。キューIDをkey、直列タスクキュー情報をvalueとする連想配列です。直列タスクキュー情報は以下の情報から構成されています。
        • queueId - キューID
        • isActive - キューの先頭のタスクを非同期処理割り当て候補とするかどうかを示すフラグ
          • true: キュー処理実行中
          • false: キュー処理停止中
        • waitingTasks - 非同期処理待機中の直列タスク情報の配列
          配列内の各要素は以下の構成を持つオブジェクトとなっています。
          • queueId - キューID
          • isStoppingProgressOnError - タスク処理中に例外が発生した場合、キュー処理を停止するかどうかを示すフラグ
            • true: 例外発生時にはキュー処理を停止する
            • false: 例外発生時であってもキュー処理を続行する
          • messageId - タスクメッセージID
          • sentTime - 送信日時
          • receivedTime - 受信日時
          • taskClassName - タスク実行クラス名
          • parameter - タスクのパラメータ
            このパラメータは バージョン 8.0.17 より利用可能です。
        • runningTask - 非同期処理実行中の直列タスク情報
          • queueId - キューID
          • isStoppingProgressOnError - タスク処理中に例外が発生した場合、キュー処理を停止するかどうかを示すフラグ
            • true: 例外発生時にはキュー処理を停止する
            • false: 例外発生時であってもキュー処理を続行する
          • messageId - タスクメッセージID
          • sentTime - 送信日時
          • receivedTime - 受信日時
          • taskClassName - タスク実行クラス名
          • node - タスクが実行されているノードのノードID
          • parameter - タスクのパラメータ
            このパラメータは バージョン 8.0.17 より利用可能です。
          • acceptTime - タスクが非同期処理として割り当てられた日時
          • startTime - タスクが非同期処理として開始された日時(まだ開始されていない場合はnull)
        • erroredTasks - 非同期処理実行時にエラー終了した直列タスク情報の配列(順序は不定)
          addSerializedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみ格納されます。
          配列内の各要素は以下の構成を持つオブジェクトとなっています。
          このパラメータは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
          • queueId - キューID
          • isStoppingProgressOnError - タスク処理中に例外が発生した場合、キュー処理を停止するかどうかを示すフラグ
            • true: 例外発生時にはキュー処理を停止する
            • false: 例外発生時であってもキュー処理を続行する
          • messageId - タスクメッセージID
          • sentTime - 送信日時
          • receivedTime - 受信日時
          • taskClassName - タスク実行クラス名
          • node - タスクが実行されているノードのノードID
          • parameter - タスクのパラメータ
          • acceptTime - タスクが非同期処理として割り当てられた日時
          • startTime - タスクが非同期処理として開始された日時(まだ開始されていない場合はnull)
  • 異常時:
    • error - true
    • data - なし
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) 以降、利用可能です。
パラメータ
queueId : String
キューID
sort : String
ソートカラム名
order : String
ソート順 。昇順 asc/降順 desc
startIndex : Number
取得開始位置(1から)
length : Number
取得件数(負数場合、全件取得)
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 現時点における登録済タスク情報のスナップショット
      • serializedTaskInfo - 指定された直列キューの待機中のタスク情報。
        • queueId - キューID
        • isStoppingProgressOnError - タスク処理中に例外が発生した場合、キュー処理を停止するかどうかを示すフラグ
          • true: 例外発生時にはキュー処理を停止する
          • false: 例外発生時であってもキュー処理を続行する
        • messageId - タスクメッセージID
        • sentTime - 送信日時
        • receivedTime - 受信日時
        • taskClassName - タスク実行クラス名
        • node - タスクが実行されたノードのノードID
        • parameter - タスクのパラメータ
        • acceptTime - タスクが非同期処理として割り当てられた日時
        • startTime - タスクが非同期処理として開始された日時(まだ開始されていない場合はnull)
      • count - エラー終了のタスク数
  • 異常時:
    • error - true
    • data - なし
ResultObject getSerializedTaskInfo (String queueId, String sort, String order, Number startIndex, Number length)
指定されたキューIDの直列キューの待機中のタスクを取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
パラメータ
queueId : String
キューID
sort : String
ソートカラム名
order : String
ソート順 。昇順 asc/降順 desc
startIndex : Number
取得開始位置(1から)
length : Number
取得件数(負数場合、全件取得)
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 現時点における登録済タスク情報のスナップショット
      • serializedTaskInfo - 指定された直列キューの待機中のタスク情報。
        • queueId - キューID
        • isStoppingProgressOnError - タスク処理中に例外が発生した場合、キュー処理を停止するかどうかを示すフラグ
          • true: 例外発生時にはキュー処理を停止する
          • false: 例外発生時であってもキュー処理を続行する
        • messageId - タスクメッセージID
        • sentTime - 送信日時
        • receivedTime - 受信日時
        • taskClassName - タスク実行クラス名
        • parameter - タスクのパラメータ
          このパラメータは バージョン 8.0.17 より利用可能です。
      • count - 待機中のタスク数
  • 異常時:
    • error - true
    • data - なし
ResultObject getSerializedTaskQueuesStatusById (String queueId)
指定されたキューIDのキューの状態を取得します。
このメソッドは intra-mart Accel Platform 2017 Summer (version 8.0.15) 以降、利用可能です。
パラメータ
queueId : String
キューID
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 現時点における登録済タスク情報のスナップショット
      • serializedTaskInfo - 指定された並列キューの処理中のタスク情報。
        • queueId - キューID
        • isStoppingProgressOnError - タスク処理中に例外が発生した場合、キュー処理を停止するかどうかを示すフラグ
          • true: 例外発生時にはキュー処理を停止する
          • false: 例外発生時であってもキュー処理を続行する
        • messageId - タスクメッセージID
        • sentTime - 送信日時
        • receivedTime - 受信日時
        • taskClassName - タスク実行クラス名
        • node - タスクが実行されているノードのノードID
        • parameter - タスクのパラメータ
          このパラメータは バージョン 8.0.17 より利用可能です。
        • acceptTime - タスクが非同期処理として割り当てられた日時
        • startTime - タスクが非同期処理として開始された日時(まだ開始されていない場合はnull)
      • hasRunningTasksInfo - 処理中のタスク情報があるかどうかを示すフラグ
        • true: 処理中のタスクが存在する
        • false: 処理中のタスクが存在しない
      • isActive - キューの先頭のタスクを非同期処理割り当て候補とするかどうかを示すフラグ
        • true: キュー処理実行中
        • false: キュー処理停止中
      • waitingTasksCount - 待機中のタスク数
      • runningTasksCount - 処理中のタスク数
      • erroredTasksCount - エラー終了のタスク数
        addSerializedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみカウントされます。
        このパラメータは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
      • queueId - キューID
  • 異常時:
    • error - true
    • data - なし
ResultObject getTaskStatusById (String messageId)
タスクの状況を取得します。
このメソッドは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
パラメータ
messageId : String
メッセージID
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 以下の構造を持つオブジェクト。メッセージIDに該当するタスクメッセージが存在しない場合はnull。
      • messageId - タスクメッセージID
      • queueId - キューID
      • status - タスクの状況
        • wait: 待機中
        • processing: 実行中
        • error: エラー終了
      • sentTime - 送信日時
      • receivedTime - 受信日時
      • node - タスクが実行されているノードのノードID(まだ割り当てられていない場合はnull)
      • parameter - タスクのパラメータ
      • acceptTime - タスクが非同期処理として割り当てられた日時(まだ割り当てられていない場合はnull)
      • startTime - タスクが非同期処理として開始された日時(まだ開始されていない場合はnull)
      • isQueueActive - タスクが属するキューの状態を示すフラグ
        • true: キュー処理実行中
        • false: キュー処理停止中
    • 異常時:
      • error - true
      • data - なし
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) 以降、利用可能です。
パラメータ
messageId : String
タスクメッセージID
usePreviousContext : Boolean
  • true: 前回実行時のアクセスコンテキスト情報を使用する
  • false: 現在のアクセスコンテキスト情報を使用する
[parameter] : Object
パラメータ
JSから登録したタスクである場合は以下の構造を持つオブジェクトを指定します。
  • jsPath - jsのパス
  • parameter - パラメータ
    指定できる値はaddSerializedTask# およびaddParallelizedTask# のparameterと同等の条件を満たす連想配列である必要があります。
    前回実行時のパラメータをすべて除去して再実行したい場合は、nullを指定します。
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 実際に登録されたタスクメッセージID
      ※再登録時はタスクメッセージIDをそのまま引き継ぐため、引数で渡されたタスクメッセージIDと同じ値になります。
  • 異常時:
    • error - true
    • data - なし
ResultObject releaseRunningParallelizedTask (String messageId, Boolean reentry, Boolean stop)
メッセージIDで指定された並列タスクに対して終了を通知します。

終了を通知された並列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。

このメソッドを呼び出す際、並列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。

  • 並列タスクキューの現在の処理状態にかかわらず並列タスクキューを非活性化状態にする
  • 並列タスクキューの処理状態(活性化または非活性化)は変更しない
ただし、返り値としてnullを返す場合には、非活性化状態にする指定は無視しタスクキューの処理状態は変更しません。

パラメータ
messageId : String
メッセージID
reentry : Boolean
  • true: 待機中並列タスクキューの先頭に同じタスクを追加する
  • false: 待機中並列タスクには再追加しない
stop : Boolean
  • true: 並列タスクキューの現在の処理状態にかかわらず並列タスクキューを非活性化状態にする
  • false: 並列タスクキューの処理状態(活性化または非活性化)は変更しない
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 以下の構造を持つオブジェクト。メッセージIDに該当するタスクメッセージが存在しない、または既に終了されていた場合はnull。
      • messageId - 並列タスクのメッセージID
      • isJsTask - JSから登録したタスクである場合はtrue、そうでなければfalse
      • path - 非同期処理として起動するJSのパス(isJsTask == trueの場合のみ設定される)
      • sentTime - タスク送信日時
      • receivedTime - タスク受信日時
      • taskClassName - タスク実行クラス名
      • parameter - タスクのパラメータ
        このパラメータは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
  • 異常時:
    • error - true
    • data - なし
ResultObject releaseRunningSerializedTask (String messageId, Boolean reentry, Boolean stop)
メッセージIDで指定された直列タスクに対して終了を通知します。

終了を通知された直列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。

このメソッドを呼び出す際、直列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。

  • 直列タスクキューの現在の処理状態にかかわらず直列タスクキューを非活性化状態にする
  • 直列タスクキューの処理状態(活性化または非活性化)は変更しない
ただし、返り値としてnullを返す場合には、非活性化状態にする指定は無視しタスクキューの処理状態は変更しません。

パラメータ
messageId : String
メッセージID
reentry : Boolean
  • true: 待機中直列タスクキューの先頭に同じタスクを追加する
  • false: 待機中直列タスクには再追加しない
stop : Boolean
  • true: 直列タスクキューの現在の処理状態にかかわらず直列タスクキューを非活性化状態にする
  • false: 直列タスクキューの処理状態(活性化または非活性化)は変更しない
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 以下の構造を持つオブジェクト。メッセージIDに該当するタスクメッセージが存在しない、または既に終了されていた場合はnull。
      • queueId - キューID
      • isStoppingProgressOnError - タスク処理中に例外が発生した場合、キュー処理を停止するかどうかを示すフラグ
      • messageId - 直列タスクのメッセージID
      • isJsTask - JSから登録したタスクである場合はtrue、そうでなければfalse
      • path - 非同期処理として起動するJSのパス(isJsTask == trueの場合のみ設定される)
      • sentTime - タスク送信日時
      • receivedTime - タスク受信日時
      • taskClassName - タスク実行クラス名
      • parameter - タスクのパラメータ
        このパラメータは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
  • 異常時:
    • error - true
    • data - なし
ResultObject removeErroredTask (String messageId)
指定されたエラー終了タスクを削除します。
addSerializedTask# およびaddParallelizedTask# のパラメータkeepTaskMessageOnErrorでtrueが指定され、実行時にエラーが発生して終了したタスクのみ対象です。
このメソッドは intra-mart Accel Platform 2021 Summer (version 8.0.22) 以降、利用可能です。
パラメータ
messageId : String
タスクメッセージID
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 削除したタスク情報のスナップショット。メッセージIDに該当するタスクメッセージが存在しない場合はnull。
      • queueId - キューID
        このパラメータは直列タスクの場合のみ利用可能です。
      • isStoppingProgressOnError - タスク処理中に例外が発生した場合、キュー処理を停止するかどうかを示すフラグ
        このパラメータは直列タスクの場合のみ利用可能です。
        • true: 例外発生時にはキュー処理を停止する
        • false: 例外発生時であってもキュー処理を続行する
      • messageId - タスクメッセージID
      • sentTime - 送信日時
      • receivedTime - 受信日時
      • taskClassName - タスク実行クラス名
      • node - タスクが実行されたノードのノードID
      • parameter - タスクのパラメータ
      • acceptTime - タスクが非同期処理として割り当てられた日時
      • startTime - タスクが非同期処理として開始された日時
  • 異常時:
    • error - true
    • data - なし
ResultObject removeParallelizedTask (String messageId)
指定された並列タスクを削除します。
パラメータ
messageId : String
タスクメッセージID
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data -
      • true: タスクを正常に削除した
      • false: タスクが既に削除されていた
  • 異常時:
    • error - true
    • data - なし
ResultObject removeSerializedTaskQueue (String queueId)
キューIDで指定された直列タスクキューを削除します。

キューIDで指定された直列タスクが存在しない場合は何もしません。この場合、戻り値としてfalseが返されます。

パラメータ
queueId : String
キューID
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data -
      • true: キューを削除した場合
      • false: キューを削除しなかった場合
  • 異常時:
    • error - true
    • data - なし
ResultObject removeSerializedTask (String messageId)
指定された直列タスクを削除します。
パラメータ
messageId : String
タスクメッセージID
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data -
      • true: タスクを正常に削除した
      • false: タスクが既に削除されていた
  • 異常時:
    • error - true
    • data - なし
ResultObject setParallelizedTaskQueueActive (Boolean active)
並列タスクの処理実行を開始または停止します。
パラメータ
active : Boolean
  • true: 並列タスクの処理実行を開始
  • false: 並列タスクの処理実行を停止
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - なし
  • 異常時:
    • error - true
    • data - なし
ResultObject setSerializedTaskQueueActive (String queueId, Boolean active)
キューIDで指定された直列タスクの処理実行を開始または停止します。
パラメータ
queueId : String
キューID
active : Boolean
  • true: 直列タスクの処理実行を開始
  • false: 直列タスクの処理実行を停止
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - なし
  • 異常時:
    • error - true
    • data - なし
ResultObject stopRunningParallelizedTask (String messageId, Boolean reentry, Boolean stop) 非推奨
このメソッドの代わりにreleaseRunningParallelizedTaskを利用するようにしてください。
メッセージIDで指定された現在処理中の並列タスクを強制停止します。

停止された並列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。

このメソッドを呼び出す際、並列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。

  • 並列タスクキューの現在の処理状態にかかわらず並列タスクキューを非活性化状態にする
  • 並列タスクキューの処理状態(活性化または非活性化)は変更しない
ただし、返り値としてnullを返す場合には、非活性化状態にする指定は無視しタスクキューの処理状態は変更しません。

パラメータ
messageId : String
メッセージID
reentry : Boolean
  • true: 待機中並列タスクキューの先頭に同じタスクを追加する
  • false: 待機中並列タスクには再追加しない
stop : Boolean
  • true: 並列タスクキューの現在の処理状態にかかわらず並列タスクキューを非活性化状態にする
  • false: 並列タスクキューの処理状態(活性化または非活性化)は変更しない
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 以下の構造を持つオブジェクト。メッセージIDに該当するタスクメッセージが存在しない、または既に終了されていた場合はnull。
      • messageId - 並列タスクのメッセージID
      • isJsTask - JSから登録したタスクである場合はtrue、そうでなければfalse
      • path - 非同期処理として起動するJSのパス(isJsTask == trueの場合のみ設定される)
      • sentTime - タスク送信日時
      • receivedTime - タスク受信日時
      • taskClassName - タスク実行クラス名
  • 異常時:
    • error - true
    • data - なし
ResultObject stopRunningSerializedTask (String messageId, Boolean reentry, Boolean stop) 非推奨
このメソッドの代わりにreleaseRunningSerializedTaskを利用するようにしてください。
メッセージIDで指定された現在処理中の直列タスクを強制停止します。

停止された直列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。

このメソッドを呼び出す際、直列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。

  • 直列タスクキューの現在の処理状態にかかわらず直列タスクキューを非活性化状態にする
  • 直列タスクキューの処理状態(活性化または非活性化)は変更しない
ただし、返り値としてnullを返す場合には、非活性化状態にする指定は無視しタスクキューの処理状態は変更しません。

パラメータ
messageId : String
メッセージID
reentry : Boolean
  • true: 待機中直列タスクキューの先頭に同じタスクを追加する
  • false: 待機中直列タスクには再追加しない
stop : Boolean
  • true: 直列タスクキューの現在の処理状態にかかわらず直列タスクキューを非活性化状態にする
  • false: 直列タスクキューの処理状態(活性化または非活性化)は変更しない
返却値
ResultObject
ResultObject 処理結果
  • 正常時:
    • error - false
    • data - 以下の構造を持つオブジェクト。メッセージIDに該当するタスクメッセージが存在しない、または既に終了されていた場合はnull。
      • queueId - キューID
      • isStoppingProgressOnError - タスク処理中に例外が発生した場合、キュー処理を停止するかどうかを示すフラグ
      • messageId - 直列タスクのメッセージID
      • isJsTask - JSから登録したタスクである場合はtrue、そうでなければfalse
      • path - 非同期処理として起動するJSのパス(isJsTask == trueの場合のみ設定される)
      • sentTime - タスク送信日時
      • receivedTime - タスク受信日時
      • taskClassName - タスク実行クラス名
  • 異常時:
    • error - true
    • data - なし