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).

Author:

mederly

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProgressInformation.ActivityType	There are some basic kinds of activities relevant for progress reporting.
static class	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, ProgressInformation.StateType stateType)
ProgressInformation(ProgressInformation.ActivityType activityType, ProgressInformation.StateType stateType, String message)
ProgressInformation(ProgressInformation.ActivityType activityType, ResourceShadowDiscriminator resourceShadowDiscriminator, ProgressInformation.StateType stateType)
ProgressInformation(ProgressInformation.ActivityType activityType, ResourceShadowDiscriminator resourceShadowDiscriminator, OperationResult operationResult)
ProgressInformation(ProgressInformation.ActivityType activityType, OperationResult operationResult)

Method Summary

Modifier and Type	Method	Description
String	debugDump()	Show the content of the object intended for diagnostics by system administrator.
String	debugDump(int indent)
ProgressInformation.ActivityType	getActivityType()
String	getMessage()
OperationResult	getOperationResult()
ResourceShadowDiscriminator	getResourceShadowDiscriminator()
ProgressInformation.StateType	getStateType()
void	setActivityType(ProgressInformation.ActivityType activityType)
void	setMessage(String message)
void	setOperationResult(OperationResult operationResult)
void	setResourceShadowDiscriminator(ResourceShadowDiscriminator resourceShadowDiscriminator)
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

debugDumpLazily, debugDumpLazily

Constructor Detail

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,
                           ResourceShadowDiscriminator resourceShadowDiscriminator,
                           ProgressInformation.StateType stateType)

ProgressInformation

public ProgressInformation(ProgressInformation.ActivityType activityType,
                           ResourceShadowDiscriminator resourceShadowDiscriminator,
                           OperationResult operationResult)

Method Detail

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)

getResourceShadowDiscriminator

public ResourceShadowDiscriminator getResourceShadowDiscriminator()

setResourceShadowDiscriminator

public void setResourceShadowDiscriminator(ResourceShadowDiscriminator resourceShadowDiscriminator)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

debugDump

public String debugDump()

Description copied from interface: DebugDumpable

Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.

Specified by:

debugDump in interface DebugDumpable

Returns:

content of the object intended for diagnostics by system administrator.

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

toString

public String toString()

Overrides:

toString in class Object