パッケージ jakarta.resource.spi.work

インターフェース WorkContextLifecycleListener


  • public interface WorkContextLifecycleListener
    このクラスは、Work インスタンスに関連付けられた WorkContext の処理中に発生するさまざまなイベントをモデル化します。このインターフェースは、WorkContext が関連付けられている Work インスタンスの実行コンテキストとして設定されている場合に、WorkManager から通知を受信するために WorkContext インスタンスによって実装される場合があります。

    WorkManager が WorkContextProvider を実装する Work インスタンスの実行コンテキストをセットアップするとき、WorkContext インスタンスがこのインターフェースを実装する場合、WorkManager は関連するライフサイクル通知を行う必要があります。

    WorkListener をパラメーターとして渡すメソッドの 1 つを使用して Work インスタンスがコネクター WorkManager に送信されると、WorkManager は Work 関連の通知を WorkListener に送信し、WorkContext セットアップ関連の通知をこのインターフェースに送信する必要があります。

    WorkContext を Work インスタンスに関連付けるときに発生する可能性のあるエラー状態は、WorkContextErrorCodes にキャプチャーされます。

    導入:
    1.6
    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   抽象メソッド  
      修飾子と型 メソッド 説明
      voidcontextSetupComplete()
      WorkContext インスタンスが Work インスタンスの実行コンテキストとして正常に設定されたときに呼び出されます。
      voidcontextSetupFailed​(StringSE errorCode)
      WorkContext インスタンスが、関連付けられている Work インスタンスの実行コンテキストとして設定されたときに呼び出されます。
    • メソッドの詳細

      • contextSetupComplete

        void contextSetupComplete()
        WorkContext インスタンスが Work インスタンスの実行コンテキストとして正常に設定されたときに呼び出されます。
        導入:
        1.6
      • contextSetupFailed

        void contextSetupFailed​(StringSE errorCode)
        WorkContext インスタンスが、関連付けられている Work インスタンスの実行コンテキストとして設定されたときに呼び出されます。
        パラメーター:
        errorCode - WorkContextErrorCodes で定義されたエラーコードまたはサブクラスの 1 つ
        導入:
        1.6
        関連事項:
        WorkContextErrorCodes