Package com.evolveum.midpoint.task.api

Class TaskRunResult

java.lang.Object
com.evolveum.midpoint.task.api.TaskRunResult
All Implemented Interfaces:
Serializable
public class TaskRunResult extends Object implements Serializable
Single-purpose class to return task run results. More than one value is returned, therefore it is bundled into a class.
Author:
Radovan Semancik
See Also:

  • Field Details

    • progress

      protected Long progress
      Progress to be recorded in the task. Null means "do not update, take whatever is in the task".

    • runResultStatus

      protected TaskRunResult.TaskRunResultStatus runResultStatus
      Final status of the run. It drives what should be done next. (E.g. repeat the run in the case of temporary errors and recurring tasks.)

    • operationResultStatus

      protected OperationResultStatus operationResultStatus
      Status to be reported to the user.

    • throwable

      protected Throwable throwable
      An exception that has occurred and that is going to be recorded at the root of the operation result. This is the "main" exception that caused the task run to be stopped. (It should be recorded somewhere in the operation result as well, if possible. But here it is designated as _the_ cause of the run being stopped.) If null, we will not overwrite the value that is computed for the result.

    • message

      protected String message
      Message that should be recorded in the root operation result. It has the same meaning as throwable. (Including the fact that if it's null, it won't overwrite whatever is in the result.)

  • Constructor Details

    • TaskRunResult

      public TaskRunResult()

  • Method Details

    • getProgress

      public Long getProgress()
      Returns:
      the progress

    • setProgress

      public void setProgress(Long progress)
      Parameters:
      progress - the progress to set

    • getRunResultStatus

      public TaskRunResult.TaskRunResultStatus getRunResultStatus()
      Returns:
      the status

    • setRunResultStatus

      public void setRunResultStatus(TaskRunResult.TaskRunResultStatus status)
      Parameters:
      status - the status to set

    • getOperationResultStatus

      public OperationResultStatus getOperationResultStatus()

    • setOperationResultStatus

      public void setOperationResultStatus(OperationResultStatus operationResultStatus)

    • getThrowable

      public Throwable getThrowable()

    • setThrowable

      public void setThrowable(Throwable throwable)

    • getMessage

      public String getMessage()

    • setMessage

      public void setMessage(String message)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • createFailureTaskRunResult

      @NotNull public static @NotNull TaskRunResult createFailureTaskRunResult(String message, Throwable t)

    • createFromTaskException

      @NotNull public static @NotNull TaskRunResult createFromTaskException(TaskException e)

    • createNotApplicableTaskRunResult

      public static TaskRunResult createNotApplicableTaskRunResult()