Package com.evolveum.midpoint.repo.common.activity

Class Activity<WD extends WorkDefinition,AH extends ActivityHandler<WD,AH>>

java.lang.Object

com.evolveum.midpoint.repo.common.activity.Activity<WD,AH>

Type Parameters:

WD - Type of the work definition object

AH - Type of the activity handler object

All Implemented Interfaces:

DebugDumpable

Direct Known Subclasses:

EmbeddedActivity, StandaloneActivity

public abstract class Activity<WD extends WorkDefinition,AH extends ActivityHandler<WD,AH>>
extends Object
implements DebugDumpable

Binds together all the information about an activity and its run (if present). The Activity itself is a binder for (shortly speaking): . (definition) ActivityDefinition . (run) AbstractActivityRun (optional - only if we are dealing with the currently executing activity) * ActivityState; . (tree) ActivityTree * ActivityTreeStateOverview . ActivityHandler

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
void	accept(@NotNull ActivityVisitor visitor)
@NotNull AbstractActivityRun<?,?,?>	createRun(ActivityBasedTaskRun taskRun, OperationResult result)	Creates and sets the activity run (run).
String	debugDump(int indent)
boolean	doesTaskExecuteTreeRootActivity(Task activityTask)
abstract @NotNull ActivityStateDefinition<?>	getActivityStateDefinition()
protected abstract @NotNull CandidateIdentifierFormatter	getCandidateIdentifierFormatter()	Returns objects that suggest child activity identifiers.
@NotNull Activity<?,?>	getChild(String identifier)
@NotNull List<Activity<?,?>>	getChildrenCopy()
@NotNull List<Activity<?,?>>	getChildrenCopyExceptSkipped()
@NotNull ActivityControlFlowDefinition	getControlFlowDefinition()
@NotNull ActivityDefinition<WD>	getDefinition()
@NotNull ActivityDistributionDefinition	getDistributionDefinition()
ActivityErrorHandlingStrategyType	getErrorHandlingStrategy()
@NotNull ExecutionModeType	getExecutionMode()
abstract AH	getHandler()
String	getIdentifier()
@Nullable ActivityPath	getLocalPath()
protected abstract @NotNull ActivityRunSupplier<WD,AH>	getLocalRunSupplier()	Returns objects that create AbstractActivityRun objects for this activity.
abstract Activity<?,?>	getParent()
@NotNull ActivityPath	getPath()
@NotNull ActivityReportingDefinition	getReportingDefinition()
AbstractActivityRun<WD,AH,?>	getRun()
@NotNull ActivityTree	getTree()
WD	getWorkDefinition()
void	initializeChildrenMapIfNeeded()
boolean	isLocalRoot()	Is this activity the local root i.e.
boolean	isRoot()	Is this activity the (global) root of the activity tree?
boolean	isSkipped()
void	setLocalRoot()
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 Detail

getIdentifier

public String getIdentifier()

getDefinition

@NotNull
public @NotNull ActivityDefinition<WD> getDefinition()

getWorkDefinition

@NotNull
public WD getWorkDefinition()

getDistributionDefinition

@NotNull
public @NotNull ActivityDistributionDefinition getDistributionDefinition()

getReportingDefinition

@NotNull
public @NotNull ActivityReportingDefinition getReportingDefinition()

getControlFlowDefinition

@NotNull
public @NotNull ActivityControlFlowDefinition getControlFlowDefinition()

getHandler

@NotNull
public abstract AH getHandler()

getLocalRunSupplier

@NotNull
protected abstract @NotNull ActivityRunSupplier<WD,AH> getLocalRunSupplier()

Returns objects that create AbstractActivityRun objects for this activity. It is used in cases where the activity runs locally i.e. is not delegated nor distributed. See ActivityRunSupplier.

getCandidateIdentifierFormatter

@NotNull
protected abstract @NotNull CandidateIdentifierFormatter getCandidateIdentifierFormatter()

Returns objects that suggest child activity identifiers.

getActivityStateDefinition

@NotNull
public abstract @NotNull ActivityStateDefinition<?> getActivityStateDefinition()

getRun

public AbstractActivityRun<WD,AH,?> getRun()

getTree

@NotNull
public @NotNull ActivityTree getTree()

setLocalRoot

public void setLocalRoot()

getParent

public abstract Activity<?,?> getParent()

getChildrenCopy

@NotNull
public @NotNull List<Activity<?,?>> getChildrenCopy()

getChildrenCopyExceptSkipped

@NotNull
public @NotNull List<Activity<?,?>> getChildrenCopyExceptSkipped()

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

createRun

@NotNull
public @NotNull AbstractActivityRun<?,?,?> createRun(ActivityBasedTaskRun taskRun,
                                                                 OperationResult result)

Creates and sets the activity run (run).

doesTaskExecuteTreeRootActivity

public boolean doesTaskExecuteTreeRootActivity(Task activityTask)

getChild

@NotNull
public @NotNull Activity<?,?> getChild(String identifier)
                                      throws SchemaException

Throws:

SchemaException

initializeChildrenMapIfNeeded

public void initializeChildrenMapIfNeeded()
                                   throws SchemaException

Throws:

SchemaException

isRoot

public boolean isRoot()

Is this activity the (global) root of the activity tree?

isLocalRoot

public boolean isLocalRoot()

Is this activity the local root i.e. root of run in the current task?

toString

public String toString()

Overrides:

toString in class Object

getPath

@NotNull
public @NotNull ActivityPath getPath()

getLocalPath

@Nullable
public @Nullable ActivityPath getLocalPath()

getErrorHandlingStrategy

public ActivityErrorHandlingStrategyType getErrorHandlingStrategy()

accept

public void accept(@NotNull
                   @NotNull ActivityVisitor visitor)

isSkipped

public boolean isSkipped()

getExecutionMode

@NotNull
public @NotNull ExecutionModeType getExecutionMode()