java.lang.Object
- com.evolveum.midpoint.schema.result.OperationResult

All Implemented Interfaces:

Visitable<OperationResult>, OperationResultBuilder, DebugDumpable, ShortDumpable, Serializable, Cloneable
```
public class OperationResult
extends Object
implements Serializable, DebugDumpable, ShortDumpable, Cloneable, OperationResultBuilder, Visitable<OperationResult>
```
Nested Operation Result.
This class provides information for better error handling in complex operations. It contains a status (success, failure, warning, ...) and an error message. It also contains a set of sub-results - results on inner operations.
This object can be used by GUI to display smart (and interactive) error information. It can also be used by the client code to detect deeper problems in the invocations, retry or otherwise compensate for the errors or decide how severe the error was and it is possible to proceed.

Author:

lazyman, Radovan Semancik

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OperationResult.PreviewResult

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CONTEXT_IMPLEMENTATION_CLASS`
`static String`	`CONTEXT_ITEM`
`static String`	`CONTEXT_OBJECT`
`static String`	`CONTEXT_OID`
`static String`	`CONTEXT_PROGRESS`
`static String`	`CONTEXT_REASON`
`static String`	`DEFAULT`
`static String`	`PARAM_LANGUAGE`
`static String`	`PARAM_NAME`
`static String`	`PARAM_OBJECT`
`static String`	`PARAM_OID`
`static String`	`PARAM_OPTIONS`
`static String`	`PARAM_PROJECTION`
`static String`	`PARAM_QUERY`
`static String`	`PARAM_TASK`
`static String`	`PARAM_TYPE`
`static String`	`RETURN_COMMENT`
`static String`	`RETURN_COUNT`

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

Constructor Summary

Constructors
Constructor	Description
`OperationResult(String operation)`
`OperationResult(String operation, OperationResultStatus status, LocalizableMessage userFriendlyMessage)`
`OperationResult(String operation, OperationResultStatus status, String message)`
`OperationResult(String operation, Map<String,Collection<String>> params, OperationResultStatus status, long token, String messageCode, String message, LocalizableMessage userFriendlyMessage, Throwable cause, List<OperationResult> subresults)`
`OperationResult(String operation, Map<String,Collection<String>> params, Map<String,Collection<String>> context, Map<String,Collection<String>> returns, OperationResultStatus status, long token, String messageCode, String message, LocalizableMessage userFriendlyMessage, Throwable cause, List<OperationResult> subresults)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(Visitor<OperationResult> visitor)`
`OperationResult`	`addArbitraryObjectAsContext(String name, Object value)`
`OperationResult`	`addArbitraryObjectAsParam(String paramName, Object paramValue)`
`void`	`addArbitraryObjectAsReturn(String name, Object value)`
`OperationResult`	`addArbitraryObjectCollectionAsContext(String paramName, Collection<?> paramValue)`
`OperationResult`	`addArbitraryObjectCollectionAsParam(String name, Collection<?> value)`
`void`	`addArbitraryObjectCollectionAsReturn(String paramName, Collection<?> paramValue)`
`OperationResult`	`addContext(String name, boolean value)`
`OperationResult`	`addContext(String name, int value)`
`OperationResult`	`addContext(String name, long value)`
`OperationResult`	`addContext(String name, ObjectDelta<?> value)`
`OperationResult`	`addContext(String name, PolyString value)`
`OperationResult`	`addContext(String name, PrismObject<? extends ObjectType> value)`
`OperationResult`	`addContext(String name, ObjectQuery value)`
`OperationResult`	`addContext(String name, ObjectType value)`
`OperationResult`	`addContext(String name, Class<?> value)`
`OperationResult`	`addContext(String name, String value)`
`OperationResult`	`addContext(String name, String... values)`
`OperationResult`	`addContext(String name, QName value)`
`OperationResult`	`addParam(String name, boolean value)`
`OperationResult`	`addParam(String name, int value)`
`OperationResult`	`addParam(String name, long value)`
`OperationResult`	`addParam(String name, ObjectDelta<?> value)`
`OperationResult`	`addParam(String name, PolyString value)`
`OperationResult`	`addParam(String name, PrismObject<? extends ObjectType> value)`
`OperationResult`	`addParam(String name, ObjectQuery value)`
`OperationResult`	`addParam(String name, ObjectType value)`
`OperationResult`	`addParam(String name, Class<?> value)`
`OperationResult`	`addParam(String name, String value)`
`OperationResult`	`addParam(String name, String... values)`
`OperationResult`	`addParam(String name, QName value)`
`OperationResult`	`addQualifier(String value)`
`void`	`addReturn(String name, boolean value)`
`void`	`addReturn(String name, int value)`
`void`	`addReturn(String name, long value)`
`void`	`addReturn(String name, ObjectDelta<?> value)`
`void`	`addReturn(String name, PolyString value)`
`void`	`addReturn(String name, PrismObject<? extends ObjectType> value)`
`void`	`addReturn(String name, ObjectQuery value)`
`void`	`addReturn(String name, ObjectType value)`
`void`	`addReturn(String name, Class<?> value)`
`void`	`addReturn(String name, String value)`
`void`	`addReturn(String name, String... values)`
`void`	`addReturn(String name, QName value)`
`void`	`addReturnComment(String comment)`
`void`	`addSubresult(OperationResult subresult)`
`void`	`addTrace(TraceType trace)`
`void`	`appendDetail(String detailLine)`
`static void`	`applyOperationResultHandlingStrategy(@NotNull List<OperationResultHandlingStrategyType> configuredStrategies)`
`OperationResult`	`build()`
`boolean`	`canBeCleanedUp()`
`void`	`checkLogRecorderFlushed()`	Checks if the recorder was correctly flushed.
`void`	`cleanupResult()`	Removes all the successful minor results.
`void`	`cleanupResult(Throwable e)`	Removes all the successful minor results.
`void`	`cleanupResultDeeply()`
`void`	`clearTracingProfile()`
`OperationResult`	`clone()`
`OperationResult`	`clone(Integer maxDepth, boolean full)`
`void`	`close()`
`OperationResult.PreviewResult`	`computePreview()`
`void`	`computeStatus()`	Computes operation result status based on subtask status.
`void`	`computeStatus(boolean skipFinish)`
`void`	`computeStatus(String errorMessage)`	Computes operation result status based on subtask status and sets an error message if the status is FATAL_ERROR.
`void`	`computeStatus(String errorMessage, String warnMessage)`
`void`	`computeStatusComposite()`	Used when the result contains several composite sub-result that are of equivalent meaning.
`void`	`computeStatusIfUnknown()`
`void`	`computeStatusIfUnknownComposite()`
`static OperationResultBuilder`	`createFor(String operation)`
`OperationResult`	`createMinorSubresult(String operation)`
`static OperationResult`	`createOperationResult(OperationResultType bean)`
`@NotNull OperationResultType`	`createOperationResultType()`
`@NotNull OperationResultType`	`createOperationResultType(Function<LocalizableMessage,String> resolveKeys)`
`OperationResult`	`createSubresult(String operation)`
`static OperationResult`	`createSubResultOrNewResult(OperationResult parentResult, String operation)`
`String`	`debugDump(int indent)`
`void`	`deleteLastSubresultIfError()`
`String`	`dump(boolean withStack)`
`boolean`	`equals(Object o)`
`String`	`findAsynchronousOperationReference()`	This method partially duplicates functionality of computeStatus.
`OperationResult`	`findSubresult(String operation)`
`List<OperationResult>`	`findSubresults(String operation)`	Finds given operation among subresults of the current op.
`@NotNull List<OperationResult>`	`findSubresultsDeeply(@NotNull String operation)`	Finds given operation in a subtree rooted by the current op.
`OperationResult`	`findSubResultStrictly(String operation)`
`String`	`getAsynchronousOperationReference()`	Reference to an asynchronous operation that can be used to retrieve the status of the running operation.
`String`	`getCallerReason()`
`Throwable`	`getCause()`
`OperationResultStatus`	`getComputeStatus()`
`@NotNull Map<String,Collection<String>>`	`getContext()`
`@Nullable ParamsType`	`getContextBean()`
`int`	`getCount()`
`Long`	`getCpuMicroseconds()`
`List<String>`	`getDetail()`
`Long`	`getEnd()`
`TraceDictionaryType`	`getExtractedDictionary()`
`<T> T`	`getFirstTrace(Class<T> traceClass)`
`int`	`getHiddenRecordsCount()`
`OperationResultImportanceType`	`getImportance()`
`Long`	`getInvocationId()`
`OperationResult`	`getLastSubresult()`
`OperationResultStatus`	`getLastSubresultStatus()`
`List<LogSegmentType>`	`getLogSegments()`
`String`	`getMessage()`
`String`	`getMessageCode()`	Contains message code based on module error catalog.
`Long`	`getMicroseconds()`
`MonitoredOperationsStatisticsType`	`getMonitoredOperations()`
`String`	`getOperation()`	Contains operation name.
`OperationKindType`	`getOperationKind()`
`Collection<String>`	`getParam(String name)`
`@NotNull Map<String,Collection<String>>`	`getParams()`	Method returns `Map` with operation parameters.
`@Nullable ParamsType`	`getParamsBean()`
`String`	`getParamSingle(String name)`
`@NotNull List<String>`	`getQualifiers()`
`Stream<OperationResult>`	`getResultStream()`
`Collection<String>`	`getReturn(String name)`
`@NotNull Map<String,Collection<String>>`	`getReturns()`
`@Nullable ParamsType`	`getReturnsBean()`
`String`	`getReturnSingle(String name)`
`Long`	`getStart()`
`OperationResultStatus`	`getStatus()`	Contains operation status as defined in `OperationResultStatus`
`OperationResultStatusType`	`getStatusBean()`
`@NotNull List<OperationResult>`	`getSubresults()`	Method returns list of operation subresults `OperationResult`.
`long`	`getToken()`
`List<TraceType>`	`getTraces()`
`@NotNull TracingLevelType`	`getTracingLevel(Class<? extends TraceType> traceClass)`
`CompiledTracingProfile`	`getTracingProfile()`
`LocalizableMessage`	`getUserFriendlyMessage()`
`int`	`hashCode()`
`boolean`	`hasUnknownStatus()`	Returns true if result status is UNKNOWN or any of the subresult status is unknown (recursive).
`void`	`incrementCount()`
`boolean`	`isAcceptable()`	Returns true if the result is acceptable for further processing.
`boolean`	`isEmpty()`
`boolean`	`isError()`
`boolean`	`isFatalError()`
`boolean`	`isHandledError()`
`boolean`	`isInProgress()`
`static boolean`	`isLesserThan(OperationResultImportanceType x, @NotNull OperationResultImportanceType y)`
`boolean`	`isMinor()`
`boolean`	`isNotApplicable()`
`boolean`	`isPartialError()`
`boolean`	`isPreserve()`
`boolean`	`isSuccess()`	Returns true if the result is success.
`boolean`	`isSummarizeErrors()`
`boolean`	`isSummarizePartialErrors()`
`boolean`	`isSummarizeSuccesses()`
`static boolean`	`isTaskOid(String ref)`
`boolean`	`isTraced()`
`boolean`	`isTracing(Class<? extends TraceType> traceClass, TracingLevelType threshold)`
`boolean`	`isTracingAny(Class<? extends TraceType> traceClass)`
`boolean`	`isTracingDetailed(Class<? extends TraceType> traceClass)`
`boolean`	`isTracingNormal(Class<? extends TraceType> traceClass)`
`boolean`	`isUnknown()`
`boolean`	`isWarning()`
`OperationResult`	`keepRootOnly()`
`static OperationResult`	`keepRootOnly(OperationResult result)`
`void`	`muteError()`	If the operation is an error then it will switch the status to HANDLED_ERROR.
`void`	`muteErrorsRecursively()`	Set all error status in this result and all subresults as handled.
`void`	`muteLastSubresultError()`
`OperationResult`	`operationKind(OperationKindType value)`
`OperationResultBuilder`	`preserve()`
`void`	`recomputeStatus()`
`void`	`recomputeStatus(String errorMessage)`
`void`	`recomputeStatus(String errorMessage, String warningMessage)`
`void`	`record(CommonException exception)`	Records result from a common exception type.
`void`	`recordEnd()`
`void`	`recordFatalError(String message)`
`void`	`recordFatalError(String message, Throwable cause)`
`void`	`recordFatalError(Throwable cause)`
`void`	`recordFatalErrorIfNeeded(Throwable t)`	Records a fatal error if it was not recorded before.
`void`	`recordFatalErrorNotFinish(String message, Throwable cause)`
`void`	`recordFatalErrorNotFinish(Throwable cause)`
`void`	`recordHandledError(String message)`
`void`	`recordHandledError(String message, Throwable cause)`
`void`	`recordHandledError(Throwable cause)`
`void`	`recordInProgress()`
`void`	`recordNotApplicable()`
`void`	`recordNotApplicable(String message)`
`void`	`recordNotApplicableIfUnknown()`
`void`	`recordPartialError(String message)`
`void`	`recordPartialError(String message, Throwable cause)`
`void`	`recordPartialError(Throwable cause)`
`void`	`recordStatus(OperationResultStatus status)`
`void`	`recordStatus(OperationResultStatus status, String message)`
`void`	`recordStatus(OperationResultStatus status, String message, Throwable cause)`
`void`	`recordStatus(OperationResultStatus status, Throwable cause)`
`void`	`recordSuccess()`
`void`	`recordSuccessIfUnknown()`
`void`	`recordThrowableIfNeeded(Throwable t)`
`void`	`recordWarning(String message)`
`void`	`recordWarning(String message, Throwable cause)`
`void`	`recordWarning(Throwable cause)`
`static String`	`referenceToCaseOid(String ref)`
`static String`	`referenceToTaskOid(String ref)`
`void`	`removeLastSubresult()`
`boolean`	`representsHiddenRecords()`
`void`	`setAsynchronousOperationReference(String asynchronousOperationReference)`
`void`	`setBackgroundTaskOid(String oid)`
`void`	`setCallerReason(String callerReason)`
`void`	`setCaseOid(String oid)`
`void`	`setCount(int count)`
`void`	`setCpuMicroseconds(Long cpuMicroseconds)`
`void`	`setEnd(Long end)`
`void`	`setExtractedDictionary(TraceDictionaryType extractedDictionary)`
`void`	`setHiddenRecordsCount(int hiddenRecordsCount)`
`OperationResult`	`setImportance(OperationResultImportanceType value)`
`void`	`setInProgress()`
`void`	`setInProgress(String message)`
`void`	`setInvocationId(Long invocationId)`
`void`	`setMessage(String message)`
`void`	`setMicroseconds(Long microseconds)`
`OperationResultBuilder`	`setMinor()`
`void`	`setMonitoredOperations(MonitoredOperationsStatisticsType operations)`
`void`	`setStart(Long start)`
`void`	`setStatus(OperationResultStatus status)`	Sets the status _without_ recording operation end.
`void`	`setSuccess()`
`void`	`setSummarizeErrors(boolean summarizeErrors)`
`void`	`setSummarizePartialErrors(boolean summarizePartialErrors)`
`void`	`setSummarizeSuccesses(boolean summarizeSuccesses)`
`static void`	`setThreadLocalHandlingStrategy(@Nullable String strategyName)`
`void`	`setUnknown()`
`void`	`setUserFriendlyMessage(LocalizableMessage userFriendlyMessage)`
`void`	`shortDump(StringBuilder sb)`	Show the content of the object intended for diagnostics.
`OperationResultBuilder`	`subresult(String operation)`
`void`	`summarize()`
`void`	`summarize(boolean alsoSubresults)`
`void`	`switchHandledErrorToSuccess()`	This is used in situations where handled error is actually the success.
`String`	`toString()`
`OperationResultBuilder`	`tracingProfile(CompiledTracingProfile profile)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable
debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.util.ShortDumpable
shortDump, shortDumpLazily

Field Detail

CONTEXT_IMPLEMENTATION_CLASS

public static final String CONTEXT_IMPLEMENTATION_CLASS

See Also:: Constant Field Values

CONTEXT_PROGRESS

public static final String CONTEXT_PROGRESS

See Also:: Constant Field Values

CONTEXT_OID
```
public static final String CONTEXT_OID
```
See Also:

Constant Field Values

CONTEXT_OBJECT

public static final String CONTEXT_OBJECT

See Also:: Constant Field Values

CONTEXT_ITEM

public static final String CONTEXT_ITEM

See Also:: Constant Field Values

CONTEXT_REASON

public static final String CONTEXT_REASON

See Also:: Constant Field Values

PARAM_OID
```
public static final String PARAM_OID
```
See Also:

Constant Field Values

PARAM_NAME
```
public static final String PARAM_NAME
```
See Also:

Constant Field Values

PARAM_TYPE
```
public static final String PARAM_TYPE
```
See Also:

Constant Field Values

PARAM_OPTIONS

public static final String PARAM_OPTIONS

See Also:: Constant Field Values

PARAM_TASK
```
public static final String PARAM_TASK
```
See Also:

Constant Field Values

PARAM_OBJECT

public static final String PARAM_OBJECT

See Also:: Constant Field Values

PARAM_QUERY
```
public static final String PARAM_QUERY
```
See Also:

Constant Field Values

PARAM_PROJECTION

public static final String PARAM_PROJECTION

See Also:: Constant Field Values

PARAM_LANGUAGE

public static final String PARAM_LANGUAGE

See Also:: Constant Field Values

RETURN_COUNT

public static final String RETURN_COUNT

See Also:: Constant Field Values

RETURN_COMMENT

public static final String RETURN_COMMENT

See Also:: Constant Field Values

DEFAULT
```
public static final String DEFAULT
```
See Also:

Constant Field Values

Constructor Detail

OperationResult

public OperationResult(String operation)

OperationResult

public OperationResult(String operation,
                       OperationResultStatus status,
                       LocalizableMessage userFriendlyMessage)

OperationResult

public OperationResult(String operation,
                       OperationResultStatus status,
                       String message)

OperationResult

public OperationResult(String operation,
                       Map<String,Collection<String>> params,
                       OperationResultStatus status,
                       long token,
                       String messageCode,
                       String message,
                       LocalizableMessage userFriendlyMessage,
                       Throwable cause,
                       List<OperationResult> subresults)

OperationResult

public OperationResult(String operation,
                       Map<String,Collection<String>> params,
                       Map<String,Collection<String>> context,
                       Map<String,Collection<String>> returns,
                       OperationResultStatus status,
                       long token,
                       String messageCode,
                       String message,
                       LocalizableMessage userFriendlyMessage,
                       Throwable cause,
                       List<OperationResult> subresults)

Method Detail

keepRootOnly

public static OperationResult keepRootOnly(OperationResult result)

keepRootOnly
```
public OperationResult keepRootOnly()
```

subresult

public OperationResultBuilder subresult(String operation)

createFor

public static OperationResultBuilder createFor(String operation)

build
```
public OperationResult build()
```
Specified by:

build in interface OperationResultBuilder

createSubresult

public OperationResult createSubresult(String operation)

createMinorSubresult

public OperationResult createMinorSubresult(String operation)

recordEnd
```
public void recordEnd()
```

checkLogRecorderFlushed
```
public void checkLogRecorderFlushed()
```
Checks if the recorder was correctly flushed. Used before writing the trace file.

getAsynchronousOperationReference
```
public String getAsynchronousOperationReference()
```
Reference to an asynchronous operation that can be used to retrieve the status of the running operation. This may be a task identifier, identifier of a ticket in ITSM system or anything else. The exact format of this reference depends on the operation which is being executed.

setAsynchronousOperationReference

public void setAsynchronousOperationReference(String asynchronousOperationReference)

findAsynchronousOperationReference
```
public String findAsynchronousOperationReference()
```
This method partially duplicates functionality of computeStatus. However, computeStatus currently does not propagate taskOid from tasks switched to background, because switchToBackground sets its result to SUCCESS (not IN_PROGRESS) because of some historical reasons. So, until this is fixed somehow, this is a bit of hack to fetch asynchronous operation reference even in such cases.

isTaskOid

public static boolean isTaskOid(String ref)

referenceToTaskOid

public static String referenceToTaskOid(String ref)

referenceToCaseOid

public static String referenceToCaseOid(String ref)

getOperation
```
public String getOperation()
```
Contains operation name. Operation name must be defined as String constant in module interface with description and possible parameters. It can be used for further processing. It will be used as key for translation in admin-gui.

Returns:

always return non null, non empty string

getCount
```
public int getCount()
```

setCount
```
public void setCount(int count)
```

incrementCount
```
public void incrementCount()
```

getHiddenRecordsCount
```
public int getHiddenRecordsCount()
```

setHiddenRecordsCount

public void setHiddenRecordsCount(int hiddenRecordsCount)

representsHiddenRecords

public boolean representsHiddenRecords()

isSummarizeErrors
```
public boolean isSummarizeErrors()
```

setSummarizeErrors

public void setSummarizeErrors(boolean summarizeErrors)

isSummarizePartialErrors

public boolean isSummarizePartialErrors()

setSummarizePartialErrors

public void setSummarizePartialErrors(boolean summarizePartialErrors)

isSummarizeSuccesses
```
public boolean isSummarizeSuccesses()
```

setSummarizeSuccesses

public void setSummarizeSuccesses(boolean summarizeSuccesses)

isEmpty
```
public boolean isEmpty()
```

getSubresults
```
@NotNull
public @NotNull List<OperationResult> getSubresults()
```
Method returns list of operation subresults OperationResult.

getLastSubresult
```
public OperationResult getLastSubresult()
```
Returns:

last subresult, or null if there are no subresults.

removeLastSubresult
```
public void removeLastSubresult()
```

getLastSubresultStatus
```
public OperationResultStatus getLastSubresultStatus()
```
Returns:

last subresult status, or null if there are no subresults.

addSubresult

public void addSubresult(OperationResult subresult)

findSubresult

public OperationResult findSubresult(String operation)

findSubresultsDeeply

@NotNull
public @NotNull List<OperationResult> findSubresultsDeeply(@NotNull
                                                           @NotNull String operation)

Finds given operation in a subtree rooted by the current op. result. Includes this one!

findSubresults
```
public List<OperationResult> findSubresults(String operation)
```
Finds given operation among subresults of the current op. result.

getStatus
```
public OperationResultStatus getStatus()
```
Contains operation status as defined in OperationResultStatus

Returns:

never returns null

getStatusBean

public OperationResultStatusType getStatusBean()

setStatus

public void setStatus(OperationResultStatus status)

Sets the status _without_ recording operation end.

isSuccess
```
public boolean isSuccess()
```
Returns true if the result is success.
This returns true if the result is absolute success. Presence of partial failures or warnings fail this test.

Returns:

true if the result is success.

isWarning
```
public boolean isWarning()
```

isAcceptable
```
public boolean isAcceptable()
```
Returns true if the result is acceptable for further processing.
In other words: if there were no fatal errors. Warnings and partial errors are acceptable. Yet, this test also fails if the operation state is not known.

Returns:

true if the result is acceptable for further processing.

isUnknown
```
public boolean isUnknown()
```

isInProgress
```
public boolean isInProgress()
```

isError
```
public boolean isError()
```

isFatalError
```
public boolean isFatalError()
```

isPartialError
```
public boolean isPartialError()
```

isHandledError
```
public boolean isHandledError()
```

isNotApplicable
```
public boolean isNotApplicable()
```

muteErrorsRecursively
```
public void muteErrorsRecursively()
```
Set all error status in this result and all subresults as handled.

computeStatus
```
public void computeStatus(String errorMessage)
```
Computes operation result status based on subtask status and sets an error message if the status is FATAL_ERROR.

Parameters:

errorMessage - error message

computeStatus

public void computeStatus(String errorMessage,
                          String warnMessage)

computeStatus
```
public void computeStatus()
```
Computes operation result status based on subtask status.

computeStatus

public void computeStatus(boolean skipFinish)

computeStatusComposite
```
public void computeStatusComposite()
```
Used when the result contains several composite sub-result that are of equivalent meaning. If all of them fail the result will be fatal error as well. If only some of them fail the result will be partial error. Handled error is considered a success.

addTrace

public void addTrace(TraceType trace)

tracingProfile

public OperationResultBuilder tracingProfile(CompiledTracingProfile profile)

Specified by:: tracingProfile in interface OperationResultBuilder

getFirstTrace

public <T> T getFirstTrace(Class<T> traceClass)

addReturnComment

public void addReturnComment(String comment)

isTracingNormal

public boolean isTracingNormal(Class<? extends TraceType> traceClass)

isTracingAny

public boolean isTracingAny(Class<? extends TraceType> traceClass)

isTracingDetailed

public boolean isTracingDetailed(Class<? extends TraceType> traceClass)

isTracing

public boolean isTracing(Class<? extends TraceType> traceClass,
                         TracingLevelType threshold)

getTracingLevel

@NotNull
public @NotNull TracingLevelType getTracingLevel(Class<? extends TraceType> traceClass)

clearTracingProfile
```
public void clearTracingProfile()
```

accept
```
public void accept(Visitor<OperationResult> visitor)
```
Specified by:

accept in interface Visitable<OperationResult>

getResultStream

public Stream<OperationResult> getResultStream()

findSubResultStrictly

public OperationResult findSubResultStrictly(String operation)

switchHandledErrorToSuccess
```
@Experimental
public void switchHandledErrorToSuccess()
```
This is used in situations where handled error is actually the success. For example, when writing an operation execution record to an object which we expect to be deleted, we consider such an operation to be a success. We do not want to bother user or administrator with the information that there was something that went wrong - when, in fact, it was really expected.

computePreview

public OperationResult.PreviewResult computePreview()

getComputeStatus

public OperationResultStatus getComputeStatus()

close
```
public void close()
```

computeStatusIfUnknown
```
public void computeStatusIfUnknown()
```

computeStatusIfUnknownComposite

public void computeStatusIfUnknownComposite()

recomputeStatus
```
public void recomputeStatus()
```

recomputeStatus

public void recomputeStatus(String errorMessage)

recomputeStatus

public void recomputeStatus(String errorMessage,
                            String warningMessage)

recordSuccessIfUnknown
```
public void recordSuccessIfUnknown()
```

recordNotApplicableIfUnknown

public void recordNotApplicableIfUnknown()

recordNotApplicable
```
public void recordNotApplicable()
```

recordNotApplicable

public void recordNotApplicable(String message)

isMinor
```
public boolean isMinor()
```

getParams
```
@NotNull
public @NotNull Map<String,Collection<String>> getParams()
```
Method returns Map with operation parameters. Parameters keys are described in module interface for every operation.

getParamsBean

@Nullable
public @Nullable ParamsType getParamsBean()

getParam

public Collection<String> getParam(String name)

getParamSingle

public String getParamSingle(String name)

addQualifier
```
public OperationResult addQualifier(String value)
```
Specified by:

addQualifier in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                String value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                PrismObject<? extends ObjectType> value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                ObjectType value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                boolean value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                long value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                int value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                Class<?> value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                QName value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                PolyString value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                ObjectQuery value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                ObjectDelta<?> value)

Specified by:: addParam in interface OperationResultBuilder

addParam

public OperationResult addParam(String name,
                                String... values)

Specified by:: addParam in interface OperationResultBuilder

addArbitraryObjectAsParam

public OperationResult addArbitraryObjectAsParam(String paramName,
                                                 Object paramValue)

Specified by:: addArbitraryObjectAsParam in interface OperationResultBuilder

addArbitraryObjectCollectionAsParam

public OperationResult addArbitraryObjectCollectionAsParam(String name,
                                                           Collection<?> value)

Specified by:: addArbitraryObjectCollectionAsParam in interface OperationResultBuilder

getContext

@NotNull
public @NotNull Map<String,Collection<String>> getContext()

getContextBean

@Nullable
public @Nullable ParamsType getContextBean()

addContext

public OperationResult addContext(String name,
                                  String value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  PrismObject<? extends ObjectType> value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  ObjectType value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  boolean value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  long value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  int value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  Class<?> value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  QName value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  PolyString value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  ObjectQuery value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  ObjectDelta<?> value)

Specified by:: addContext in interface OperationResultBuilder

addContext

public OperationResult addContext(String name,
                                  String... values)

Specified by:: addContext in interface OperationResultBuilder

addArbitraryObjectAsContext

public OperationResult addArbitraryObjectAsContext(String name,
                                                   Object value)

Specified by:: addArbitraryObjectAsContext in interface OperationResultBuilder

addArbitraryObjectCollectionAsContext

public OperationResult addArbitraryObjectCollectionAsContext(String paramName,
                                                             Collection<?> paramValue)

Specified by:: addArbitraryObjectCollectionAsContext in interface OperationResultBuilder

getReturns

@NotNull
public @NotNull Map<String,Collection<String>> getReturns()

getReturnsBean

@Nullable
public @Nullable ParamsType getReturnsBean()

getReturn

public Collection<String> getReturn(String name)

getReturnSingle

public String getReturnSingle(String name)

addReturn

public void addReturn(String name,
                      String value)

addReturn

public void addReturn(String name,
                      PrismObject<? extends ObjectType> value)

addReturn

public void addReturn(String name,
                      ObjectType value)

addReturn

public void addReturn(String name,
                      boolean value)

addReturn

public void addReturn(String name,
                      long value)

addReturn

public void addReturn(String name,
                      int value)

addReturn

public void addReturn(String name,
                      Class<?> value)

addReturn

public void addReturn(String name,
                      QName value)

addReturn

public void addReturn(String name,
                      PolyString value)

addReturn

public void addReturn(String name,
                      ObjectQuery value)

addReturn

public void addReturn(String name,
                      ObjectDelta<?> value)

addReturn

public void addReturn(String name,
                      String... values)

addArbitraryObjectAsReturn

public void addArbitraryObjectAsReturn(String name,
                                       Object value)

addArbitraryObjectCollectionAsReturn

public void addArbitraryObjectCollectionAsReturn(String paramName,
                                                 Collection<?> paramValue)

getToken
```
public long getToken()
```
Returns:

Contains random long number, for better searching in logs.

getMessageCode
```
public String getMessageCode()
```
Contains message code based on module error catalog.

Returns:

Can return null.

getMessage
```
public String getMessage()
```
Returns:

Method returns operation result message. Message is required. It will be key for translation in admin-gui.

setMessage

public void setMessage(String message)

getUserFriendlyMessage

public LocalizableMessage getUserFriendlyMessage()

setUserFriendlyMessage

public void setUserFriendlyMessage(LocalizableMessage userFriendlyMessage)

getCause
```
public Throwable getCause()
```
Returns:

Method returns operation result exception. Not required, can be null.

recordSuccess
```
public void recordSuccess()
```

setSuccess
```
public void setSuccess()
```

recordInProgress
```
public void recordInProgress()
```

setInProgress
```
public void setInProgress()
```

setInProgress

public void setInProgress(String message)

setUnknown
```
public void setUnknown()
```

recordFatalError

public void recordFatalError(Throwable cause)

recordFatalErrorIfNeeded
```
@Experimental
public void recordFatalErrorIfNeeded(Throwable t)
```
Records a fatal error if it was not recorded before. TODO Not 100% safe, because the fatal error could be recorded for some other reason. We have to improve error reporting in general.

recordFatalErrorNotFinish

public void recordFatalErrorNotFinish(Throwable cause)

recordFatalErrorNotFinish

public void recordFatalErrorNotFinish(String message,
                                      Throwable cause)

muteError
```
public void muteError()
```
If the operation is an error then it will switch the status to HANDLED_ERROR. This is used if the error is expected and properly handled.

muteLastSubresultError
```
public void muteLastSubresultError()
```

deleteLastSubresultIfError

public void deleteLastSubresultIfError()

recordPartialError

public void recordPartialError(Throwable cause)

recordWarning

public void recordWarning(Throwable cause)

recordStatus

public void recordStatus(OperationResultStatus status,
                         Throwable cause)

recordFatalError

public void recordFatalError(String message,
                             Throwable cause)

recordPartialError

public void recordPartialError(String message,
                               Throwable cause)

recordWarning

public void recordWarning(String message,
                          Throwable cause)

recordHandledError

public void recordHandledError(String message)

recordHandledError

public void recordHandledError(String message,
                               Throwable cause)

recordHandledError

public void recordHandledError(Throwable cause)

recordStatus

public void recordStatus(OperationResultStatus status,
                         String message,
                         Throwable cause)

recordFatalError

public void recordFatalError(String message)

recordPartialError

public void recordPartialError(String message)

recordWarning

public void recordWarning(String message)

record
```
public void record(CommonException exception)
```
Records result from a common exception type. This automatically determines status and also sets appropriate message.

Parameters:

exception - common exception

recordStatus

public void recordStatus(OperationResultStatus status)

recordStatus

public void recordStatus(OperationResultStatus status,
                         String message)

hasUnknownStatus
```
public boolean hasUnknownStatus()
```
Returns true if result status is UNKNOWN or any of the subresult status is unknown (recursive).
May come handy in tests to check if all the operations fill out the status as they should.

appendDetail

public void appendDetail(String detailLine)

getDetail
```
public List<String> getDetail()
```

createOperationResult

@Contract("null -> null; !null -> !null")
public static OperationResult createOperationResult(OperationResultType bean)

createOperationResultType

@NotNull
public @NotNull OperationResultType createOperationResultType()

createOperationResultType

@NotNull
public @NotNull OperationResultType createOperationResultType(Function<LocalizableMessage,String> resolveKeys)

summarize
```
public void summarize()
```

summarize

public void summarize(boolean alsoSubresults)

cleanupResultDeeply
```
public void cleanupResultDeeply()
```

cleanupResult
```
public void cleanupResult()
```
Removes all the successful minor results. Also checks if the result is roughly consistent and complete. (e.g. does not have unknown operation status, etc.)

cleanupResult
```
public void cleanupResult(Throwable e)
```
Removes all the successful minor results. Also checks if the result is roughly consistent and complete. (e.g. does not have unknown operation status, etc.)
The argument "e" is for easier use of the cleanup in the exceptions handlers. The original exception is passed to the IAE that this method produces for easier debugging.

canBeCleanedUp
```
public boolean canBeCleanedUp()
```

isLesserThan

public static boolean isLesserThan(OperationResultImportanceType x,
                                   @NotNull
                                   @NotNull OperationResultImportanceType y)

Returns:: true if x < y

debugDump
```
public String debugDump(int indent)
```
Specified by:

debugDump in interface DebugDumpable

dump

public String dump(boolean withStack)

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

setBackgroundTaskOid

public void setBackgroundTaskOid(String oid)

setCaseOid

public void setCaseOid(String oid)

operationKind

public OperationResult operationKind(OperationKindType value)

Specified by:: operationKind in interface OperationResultBuilder

getOperationKind

public OperationKindType getOperationKind()

preserve
```
public OperationResultBuilder preserve()
```
Specified by:

preserve in interface OperationResultBuilder

isPreserve
```
public boolean isPreserve()
```

setMinor
```
public OperationResultBuilder setMinor()
```
Specified by:

setMinor in interface OperationResultBuilder

getImportance

public OperationResultImportanceType getImportance()

setImportance

public OperationResult setImportance(OperationResultImportanceType value)

Specified by:: setImportance in interface OperationResultBuilder

recordThrowableIfNeeded

public void recordThrowableIfNeeded(Throwable t)

createSubResultOrNewResult

public static OperationResult createSubResultOrNewResult(OperationResult parentResult,
                                                         String operation)

clone
```
public OperationResult clone()
```
Overrides:

clone in class Object

clone

public OperationResult clone(Integer maxDepth,
                             boolean full)

applyOperationResultHandlingStrategy

public static void applyOperationResultHandlingStrategy(@NotNull
                                                        @NotNull List<OperationResultHandlingStrategyType> configuredStrategies)

setThreadLocalHandlingStrategy

public static void setThreadLocalHandlingStrategy(@Nullable
                                                  @Nullable String strategyName)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

getStart
```
public Long getStart()
```

setStart
```
public void setStart(Long start)
```

getEnd
```
public Long getEnd()
```

setEnd
```
public void setEnd(Long end)
```

getMicroseconds
```
public Long getMicroseconds()
```

setMicroseconds

public void setMicroseconds(Long microseconds)

getCpuMicroseconds
```
public Long getCpuMicroseconds()
```

setCpuMicroseconds

public void setCpuMicroseconds(Long cpuMicroseconds)

getInvocationId
```
public Long getInvocationId()
```

setInvocationId

public void setInvocationId(Long invocationId)

isTraced
```
public boolean isTraced()
```

getTracingProfile

public CompiledTracingProfile getTracingProfile()

getTraces
```
public List<TraceType> getTraces()
```

getMonitoredOperations

public MonitoredOperationsStatisticsType getMonitoredOperations()

setMonitoredOperations

public void setMonitoredOperations(MonitoredOperationsStatisticsType operations)

getQualifiers

@NotNull
public @NotNull List<String> getQualifiers()

getCallerReason
```
public String getCallerReason()
```

setCallerReason

public void setCallerReason(String callerReason)

getLogSegments

public List<LogSegmentType> getLogSegments()

getExtractedDictionary

public TraceDictionaryType getExtractedDictionary()

setExtractedDictionary

public void setExtractedDictionary(TraceDictionaryType extractedDictionary)

Class OperationResult

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Detail

CONTEXT_IMPLEMENTATION_CLASS

CONTEXT_PROGRESS

CONTEXT_OID

CONTEXT_OBJECT

CONTEXT_ITEM

CONTEXT_REASON

PARAM_OID

PARAM_NAME

PARAM_TYPE

PARAM_OPTIONS

PARAM_TASK

PARAM_OBJECT

PARAM_QUERY

PARAM_PROJECTION

PARAM_LANGUAGE

RETURN_COUNT

RETURN_COMMENT

DEFAULT

Constructor Detail

OperationResult

OperationResult

OperationResult

OperationResult

OperationResult

Method Detail

keepRootOnly

keepRootOnly

subresult

createFor

build

createSubresult

createMinorSubresult

recordEnd

checkLogRecorderFlushed

getAsynchronousOperationReference

setAsynchronousOperationReference

findAsynchronousOperationReference

isTaskOid

referenceToTaskOid

referenceToCaseOid

getOperation

getCount

setCount

incrementCount

getHiddenRecordsCount

setHiddenRecordsCount

representsHiddenRecords

isSummarizeErrors

setSummarizeErrors

isSummarizePartialErrors

setSummarizePartialErrors

isSummarizeSuccesses

setSummarizeSuccesses

isEmpty

getSubresults

getLastSubresult

removeLastSubresult

getLastSubresultStatus

addSubresult

findSubresult

findSubresultsDeeply

findSubresults

getStatus

getStatusBean

setStatus

isSuccess

isWarning

isAcceptable

isUnknown

isInProgress