TaskRun (midPoint Aggregate JavaDoc)

All Superinterfaces:

ShortDumpable

All Known Implementing Classes:

ActivityBasedTaskRun
```
public interface TaskRun
extends ShortDumpable
```
Represents a run of a task. Originally intended to cover multitude of tasks. However, currently there's only one implementation (for activity-based tasks). Therefore, *TODO* consider removing this interface.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default boolean`	`canRun()`
`@NotNull CommonTaskBeans`	`getBeans()`
`default Task`	`getRootTask()`
`@NotNull RunningTask`	`getRunningTask()`	Returns the task associated with this run.
`default Long`	`heartbeat()`
`default boolean`	`isRootTask()`
`@NotNull TaskRunResult`	`run(OperationResult result)`	Passes control to the run object.
`default void`	`shortDump(StringBuilder sb)`	Show the content of the object intended for diagnostics.

Methods inherited from interface com.evolveum.midpoint.util.ShortDumpable
shortDump, shortDumpLazily

- Method Detail
  - run
```
@NotNull
@NotNull TaskRunResult run(OperationResult result)
                    throws TaskException
```
    Passes control to the run object. The object is now responsible for the whole execution of this task.
    
    Throws:
    
    TaskException
  - getRunningTask
```
@NotNull
@NotNull RunningTask getRunningTask()
```
    Returns the task associated with this run.
  - getBeans
```
@NotNull
@NotNull CommonTaskBeans getBeans()
```
  - heartbeat
```
default Long heartbeat()
```
  - shortDump
```
default void shortDump(StringBuilder sb)
```
    Description copied from interface: ShortDumpable
    
    Show the content of the object intended for diagnostics. This method is supposed to append a compact, human-readable output in a single line. Unlike toString() method, there is no requirement to identify the actual class or type of the object. It is assumed that the class/type will be obvious from the context in which the output is used.
    
    Specified by:
    
    shortDump in interface ShortDumpable
    
    Parameters:
    
    sb - StringBuilder to which to a compact one-line content of the object intended for diagnostics by system administrator should be appended.
  - getRootTask
```
default Task getRootTask()
```
  - canRun
```
default boolean canRun()
```
  - isRootTask
```
default boolean isRootTask()
```