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

Class ActivityBasedTaskInformation

java.lang.Object

com.evolveum.midpoint.schema.util.task.TaskInformation

com.evolveum.midpoint.schema.util.task.ActivityBasedTaskInformation

All Implemented Interfaces:

DebugDumpable, Serializable

public class ActivityBasedTaskInformation
extends TaskInformation

Implementation of TaskInformation based on new, activity-based tasks. Assumes knowledge of both root and current task.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.evolveum.midpoint.schema.util.task.TaskInformation

overallStatus, task, workersInformation

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
String	debugDump(int indent)
Integer	getAllErrors()	Returns number of items failed to be processed by the task and its children, if known.
XMLGregorianCalendar	getEndTimestamp()	Returns the "end timestamp" with the analogous semantics to TaskInformation.getStartTimestamp().
Object	getLiveSyncToken()	We assume the token is directly in the task provided.
double	getProgress()	Returns the progress of the task based on activity tree state.
String	getProgressDescription(boolean longForm)
@NotNull ActivityProgressInformation	getProgressInformation()
@Nullable ActivityStatePersistenceType	getRootActivityStatePersistence()
XMLGregorianCalendar	getStartTimestamp()	Returns the "start timestamp", whatever that means.
LocalizableMessage	getTaskHealthDescription()	Returns the message that describes primarily the overall status (health) of the task and it's subtasks.
List<String>	getTaskHealthMessages()	Return list of technical messages that contains concrete errors/warnings that are related to the task health (plus it's subtasks).
OperationResultStatusType	getTaskHealthStatus()	Overall health status of the task and it's subtasks.
List<LocalizableMessage>	getTaskHealthUserFriendlyMessages()	Return list of localizable messages that contains concrete errors/warnings that are related to the task health (plus it's subtasks).
TaskResultStatus	getTaskUserFriendlyStatus()
boolean	isComplete()

Methods inherited from class com.evolveum.midpoint.schema.util.task.TaskInformation

createForTask, getCompletelyStalledSince, getNodesDescription, getProgressDescriptionShort, getResultStatus, getTask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

Method Details

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

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

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class TaskInformation

getLiveSyncToken

public Object getLiveSyncToken()

We assume the token is directly in the task provided.

Specified by:

getLiveSyncToken in class TaskInformation

getProgressInformation

@NotNull
public @NotNull ActivityProgressInformation getProgressInformation()

getRootActivityStatePersistence

@Nullable
public @Nullable ActivityStatePersistenceType getRootActivityStatePersistence()

Specified by:

getRootActivityStatePersistence in class TaskInformation

getTaskUserFriendlyStatus

public TaskResultStatus getTaskUserFriendlyStatus()

Specified by:

getTaskUserFriendlyStatus in class TaskInformation