Package ch.tocco.nice2.rest.action.spi

Interface TaskContext

All Known Implementing Classes:
JobTaskContext
public interface TaskContext

  • Method Details

    • isCancelled

      boolean isCancelled()

    • getProgress

      Progress getProgress()
      Get an instance of Progress to update the current progress.

      Note: will throw an IllegalStateException if the progress is not available. This might be the case if the task is not trackable or if no RemoteContext is available.

      Check if the progress is available by calling isProgressAvailable() if you're not sure.

      Returns:
      an instance of Progress
      See Also:

    • isProgressAvailable

      boolean isProgressAvailable()
      Check if the progress is available.
      Returns:
      true if the progress is available, false otherwise.

    • getProgressLog

      ProgressLog getProgressLog()
      Get an instance of ProgressLog to update the current progress log.

      Note: will throw an IllegalStateException if the progress log is not available. This might be the case if the task is not trackable.

      Check if the progress log is available by calling isProgressLogAvailable() if you're not sure.

      Returns:
      an instance of ProgressLog
      See Also:

    • isProgressLogAvailable

      boolean isProgressLogAvailable()
      Check if the progress log is available.
      Returns:
      true if the progress log is available, false otherwise.