Package com.evolveum.midpoint.schema.result

Class ResourceOperationStatus

java.lang.Object

com.evolveum.midpoint.schema.result.ResourceOperationStatus

All Implemented Interfaces:

ShortDumpable, Serializable

public class ResourceOperationStatus
extends Object
implements Serializable, ShortDumpable

Represents the status of a "modifying" operation (add, modify, delete) on a resource. == Note about `fromResult` methods that create objects of this type The content of these objects overlaps with the content of OperationResult. However, the latter is much more generic, hence the relevant data were extracted and are stored separately here. To allow simple creation of these objects, there are many utility methods named `fromResult` that create objects of this type from OperationResult. Common requirements is that the source OperationResult must be closed (so its status is available), and the asynchronous operation reference must be present at the top level.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ResourceOperationStatus(@NotNull OperationResultStatus status, @Nullable String asynchronousOperationReference, @Nullable PendingOperationTypeType operationType)

Method Summary

Modifier and Type	Method	Description
static @NotNull ResourceOperationStatus	fromResult(@NotNull OperationResult result, @Nullable PendingOperationTypeType operationType)	See the note in class javadoc.
@Nullable String	getAsynchronousOperationReference()
@Nullable PendingOperationTypeType	getOperationType()
@NotNull OperationResultStatus	getStatus()
boolean	isInProgress()
static ResourceOperationStatus	of(@NotNull OperationResultStatus status)
void	shortDump(StringBuilder sb)	Show the content of the object intended for diagnostics.
static @NotNull ResourceOperationStatus	success()
String	toString()
@NotNull ResourceOperationStatus	withStatus(@NotNull OperationResultStatus newStatus)

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

shortDump, shortDumpLazily

Constructor Details

ResourceOperationStatus

public ResourceOperationStatus(@NotNull
 @NotNull OperationResultStatus status,
 @Nullable
 @Nullable String asynchronousOperationReference,
 @Nullable
 @Nullable PendingOperationTypeType operationType)

Method Details

fromResult

@NotNull
public static @NotNull ResourceOperationStatus fromResult(@NotNull
 @NotNull OperationResult result,
 @Nullable
 @Nullable PendingOperationTypeType operationType)

See the note in class javadoc.

success

@NotNull
public static @NotNull ResourceOperationStatus success()

getStatus

@NotNull
public @NotNull OperationResultStatus getStatus()

getAsynchronousOperationReference

@Nullable
public @Nullable String getAsynchronousOperationReference()

getOperationType

@Nullable
public @Nullable PendingOperationTypeType getOperationType()

of

public static ResourceOperationStatus of(@NotNull
 @NotNull OperationResultStatus status)

isInProgress

public boolean isInProgress()

withStatus

@NotNull
public @NotNull ResourceOperationStatus withStatus(@NotNull
 @NotNull OperationResultStatus newStatus)

shortDump

public void shortDump(StringBuilder sb)

Description copied from interface: ShortDumpable

Show the content of the object intended for diagnostics. This method is supposed to append a compact, human-readable output in a single line. Unlike toString() method, there is no requirement to identify the actual class or type of the object. It is assumed that the class/type will be obvious from the context in which the output is used.

Specified by:

shortDump in interface ShortDumpable

Parameters:

sb - StringBuilder to which to a compact one-line content of the object intended for diagnostics by system administrator should be appended.

toString

public String toString()

Overrides:

toString in class Object