TaskLifeCycle (Jmix-all 2.2 API)

Type Parameters:: T - task progress measurement unit

public interface TaskLifeCycle<T>

Lifecycle object that is passed to BackgroundTask.run(TaskLifeCycle) method to allow working thread to interact with the execution environment.

Method Summary

Modifier and Type

Method

Description

Map<String,Object>

getParams()

boolean

isCancelled()

boolean

isInterrupted()

void

publish(T... changes)

Publishes changes to show progress.

Method Details
- publish
  
  void publish(T... changes) throws InterruptedException
  
  Publishes changes to show progress.
  
  Parameters:
  
  changes - Changes
  
  Throws:
  
  InterruptedException - if task was interrupted by calling BackgroundTaskHandler.cancel()
- isInterrupted
  
  boolean isInterrupted()
  
  Returns:
  
  true if the working thread has been interrupted
- isCancelled
  
  boolean isCancelled()
  
  Returns:
  
  true if a task was interrupted by calling the "cancel" method
- getParams
  
  Map<String,Object> getParams()
  
  Returns:
  
  execution parameters that was set by BackgroundTask.getParams()