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

Class ActivityProgressInformation

java.lang.Object

com.evolveum.midpoint.schema.util.task.ActivityProgressInformation

All Implemented Interfaces:

DebugDumpable, Serializable

public class ActivityProgressInformation
extends Object
implements DebugDumpable, Serializable

Summarized representation of a progress of an activity and its sub-activities. Examples: - 23% in 1/3 - 23% in 2/2 in 2/3 TODO optimize task reading: avoid doing that for completed subtasks TODO i8n NOTE: User-oriented information on the activity can be obtained by resolving the following keys (for example): - Activity.name.shadows-collection="Shadows collection" - Activity.explanation.shadows-collection="Collecting correlated shadows" The first one is used as the traditional activity name (with wording like "User recomputation", "Resource reconciliation", ...) while the second one is used to display the activity in the task progress panel - what is the task doing at the moment.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ActivityProgressInformation.RealizationState

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
void	checkConsistence()
String	debugDump(int indent)
ActivityProgressInformation	find(ActivityPath activityPath)
static @NotNull ActivityProgressInformation	fromRootTask(@NotNull TaskType task, @NotNull ActivityProgressInformationBuilder.InformationSource source)	Prepares the information from a root task.
static @NotNull ActivityProgressInformation	fromRootTask(@NotNull TaskType task, @NotNull TaskResolver resolver, @NotNull ActivityProgressInformationBuilder.InformationSource source)	Prepares the information from a root task.
@Nullable String	getActivityIdentifier()
@NotNull ActivityPath	getActivityPath()
BucketsProgressInformation	getBucketsProgress()
ActivityProgressInformation	getChild(String identifier)
@NotNull List<ActivityProgressInformation>	getChildren()
@Nullable Integer	getDisplayOrder()
int	getErrors()
int	getErrorsRecursive()
ItemsProgressInformation	getItemsProgress()
@Nullable ActivityProgressInformation.RealizationState	getRealizationState()
boolean	isComplete()
boolean	isInProgress()
boolean	isNotStarted()
String	toHumanReadableString(boolean longForm)
String	toString()

Methods inherited from class java.lang.Object

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

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

debugDump, debugDumpLazily, debugDumpLazily

Method Details

fromRootTask

@NotNull
public static @NotNull ActivityProgressInformation fromRootTask(@NotNull
 @NotNull TaskType task,
 @NotNull
 @NotNull ActivityProgressInformationBuilder.InformationSource source)

Prepares the information from a root task. The task may or may not have its children resolved.

fromRootTask

@NotNull
public static @NotNull ActivityProgressInformation fromRootTask(@NotNull
 @NotNull TaskType task,
 @NotNull
 @NotNull TaskResolver resolver,
 @NotNull
 @NotNull ActivityProgressInformationBuilder.InformationSource source)

Prepares the information from a root task. The task may or may not have its children resolved. Note: the `resolver` parameter is dubious. Consider removing it.

getActivityIdentifier

@Nullable
public @Nullable String getActivityIdentifier()

getActivityPath

@NotNull
public @NotNull ActivityPath getActivityPath()

getRealizationState

@Nullable
public @Nullable ActivityProgressInformation.RealizationState getRealizationState()

getBucketsProgress

public BucketsProgressInformation getBucketsProgress()

getItemsProgress

public ItemsProgressInformation getItemsProgress()

getChildren

@NotNull
public @NotNull List<ActivityProgressInformation> getChildren()

toString

public String toString()

Overrides:

toString in class Object

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

toHumanReadableString

public String toHumanReadableString(boolean longForm)

isInProgress

public boolean isInProgress()

isComplete

public boolean isComplete()

isNotStarted

public boolean isNotStarted()

checkConsistence

public void checkConsistence()

getDisplayOrder

@Nullable
public @Nullable Integer getDisplayOrder()

getChild

public ActivityProgressInformation getChild(String identifier)

getErrorsRecursive

public int getErrorsRecursive()

getErrors

public int getErrors()

find

public ActivityProgressInformation find(ActivityPath activityPath)