Package com.evolveum.midpoint.model.api

Class ProgressInformation

java.lang.Object

com.evolveum.midpoint.model.api.ProgressInformation

All Implemented Interfaces:

DebugDumpable, Serializable

public class ProgressInformation
extends Object
implements Serializable, DebugDumpable

Describes a state of the operation. Although theoretically everything relevant should be in the model context, as a convenience for clients interpreting this structure we offer explicit denotation of specific events (see ActivityType). HIGHLY EXPERIMENTAL. Probably should be refactored (e.g. by providing strong typing via class hierarchy).

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProgressInformation.ActivityType	There are some basic kinds of activities relevant for progress reporting.
static enum	ProgressInformation.StateType	We usually report on entering and exiting a particular activity.

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
ProgressInformation(ProgressInformation.ActivityType activityType, ProjectionContextKey projectionContextKey, ProgressInformation.StateType stateType)
ProgressInformation(ProgressInformation.ActivityType activityType, ProjectionContextKey projectionContextKey, OperationResult operationResult)
ProgressInformation(ProgressInformation.ActivityType activityType, ProgressInformation.StateType stateType)
ProgressInformation(ProgressInformation.ActivityType activityType, ProgressInformation.StateType stateType, String message)
ProgressInformation(ProgressInformation.ActivityType activityType, OperationResult operationResult)

Method Summary

Modifier and Type	Method	Description
String	debugDump(int indent)
ProgressInformation.ActivityType	getActivityType()
String	getMessage()
OperationResult	getOperationResult()
ProjectionContextKey	getProjectionContextKey()
ProgressInformation.StateType	getStateType()
void	setActivityType(ProgressInformation.ActivityType activityType)
void	setMessage(String message)
void	setOperationResult(OperationResult operationResult)
void	setProjectionContextKey(ProjectionContextKey projectionContextKey)
void	setStateType(ProgressInformation.StateType stateType)
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

Constructor Details

ProgressInformation

public ProgressInformation(ProgressInformation.ActivityType activityType,
 ProgressInformation.StateType stateType)

ProgressInformation

public ProgressInformation(ProgressInformation.ActivityType activityType,
 ProgressInformation.StateType stateType,
 String message)

ProgressInformation

public ProgressInformation(ProgressInformation.ActivityType activityType,
 OperationResult operationResult)

ProgressInformation

public ProgressInformation(ProgressInformation.ActivityType activityType,
 ProjectionContextKey projectionContextKey,
 ProgressInformation.StateType stateType)

ProgressInformation

public ProgressInformation(ProgressInformation.ActivityType activityType,
 ProjectionContextKey projectionContextKey,
 OperationResult operationResult)

Method Details

getActivityType

public ProgressInformation.ActivityType getActivityType()

setActivityType

public void setActivityType(ProgressInformation.ActivityType activityType)

getStateType

public ProgressInformation.StateType getStateType()

getOperationResult

public OperationResult getOperationResult()

setOperationResult

public void setOperationResult(OperationResult operationResult)

setStateType

public void setStateType(ProgressInformation.StateType stateType)

getProjectionContextKey

public ProjectionContextKey getProjectionContextKey()

setProjectionContextKey

public void setProjectionContextKey(ProjectionContextKey projectionContextKey)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

toString

public String toString()

Overrides:

toString in class Object