Package com.evolveum.midpoint.schema.util.task

Class LegacyTaskInformation

java.lang.Object
com.evolveum.midpoint.schema.util.task.TaskInformation
com.evolveum.midpoint.schema.util.task.LegacyTaskInformation
All Implemented Interfaces:
DebugDumpable, Serializable
public class LegacyTaskInformation extends TaskInformation
The TaskInformation based on a legacy task structure. Very limited.
See Also:

  • Method Details

    • fromLegacyTaskOrNoTask

      @NotNull public static @NotNull TaskInformation fromLegacyTaskOrNoTask(@Nullable @Nullable TaskType task)

    • getProgressDescription

      public String getProgressDescription(boolean longForm)
      Specified by:
      getProgressDescription in class TaskInformation

    • getProgress

      public double getProgress()
      Description copied from class: TaskInformation
      Returns the progress of the task based on activity tree state. Progress (%) is based on the number of completed activities to all activities. Each activity represents the same amount of work.
      Specified by:
      getProgress in class TaskInformation
      Returns:
      The progress is a number between 0 and 1. If the progress is unknown, the method returns -1.

    • isComplete

      public boolean isComplete()
      Specified by:
      isComplete in class TaskInformation

    • getTaskHealthStatus

      public OperationResultStatusType getTaskHealthStatus()
      Description copied from class: TaskInformation
      Overall health status of the task and it's subtasks. Not related to items/objects processing, rather just task execution (e.g. failed/stalled workers).
      Specified by:
      getTaskHealthStatus in class TaskInformation

    • getTaskHealthDescription

      public LocalizableMessage getTaskHealthDescription()
      Description copied from class: TaskInformation
      Returns the message that describes primarily the overall status (health) of the task and it's subtasks. Description should not be based on errors created as a result of items/objects processing, just state of tasks/subtasks and their execution. This should be a short message that is suitable for displaying to the user/table.
      Specified by:
      getTaskHealthDescription in class TaskInformation

    • getTaskHealthMessages

      public List<String> getTaskHealthMessages()
      Description copied from class: TaskInformation
      Return list of technical messages that contains concrete errors/warnings that are related to the task health (plus it's subtasks). Collected messages might repeat, therefore might not be unique. It's up to client to decide whether to filter them. E.g. Policy violation error messages.
      Specified by:
      getTaskHealthMessages in class TaskInformation

    • getTaskHealthUserFriendlyMessages

      public List<LocalizableMessage> getTaskHealthUserFriendlyMessages()
      Description copied from class: TaskInformation
      Return list of localizable messages that contains concrete errors/warnings that are related to the task health (plus it's subtasks). Collected messages might repeat, therefore might not be unique. It's up to client to decide whether to filter them. E.g. Policy violation error localizable messages.
      Specified by:
      getTaskHealthUserFriendlyMessages in class TaskInformation

    • getRootActivityStatePersistence

      @Nullable public @Nullable ActivityStatePersistenceType getRootActivityStatePersistence()
      Specified by:
      getRootActivityStatePersistence in class TaskInformation

    • getAllErrors

      public Integer getAllErrors()
      Description copied from class: TaskInformation
      Returns number of items failed to be processed by the task and its children, if known. BEWARE: Fatal errors (e.g. resource not found for import task) are not counted here.
      Specified by:
      getAllErrors in class TaskInformation

    • getStartTimestamp

      public XMLGregorianCalendar getStartTimestamp()
      Description copied from class: TaskInformation
      Returns the "start timestamp", whatever that means. Currently, it is the execution start for trivial tasks (a single non-bucketed activity, or a legacy task); and realization start otherwise.
      Specified by:
      getStartTimestamp in class TaskInformation

    • getEndTimestamp

      public XMLGregorianCalendar getEndTimestamp()
      Description copied from class: TaskInformation
      Returns the "end timestamp" with the analogous semantics to TaskInformation.getStartTimestamp().
      Specified by:
      getEndTimestamp in class TaskInformation

    • getLiveSyncToken

      public Object getLiveSyncToken()
      Specified by:
      getLiveSyncToken in class TaskInformation

    • getTaskUserFriendlyStatus

      public TaskResultStatus getTaskUserFriendlyStatus()
      Specified by:
      getTaskUserFriendlyStatus in class TaskInformation