Package com.evolveum.midpoint.model.api.correlation

Class CompleteCorrelationResult

java.lang.Object

com.evolveum.midpoint.model.api.correlation.CompleteCorrelationResult

All Implemented Interfaces:

DebugDumpable, Serializable

public class CompleteCorrelationResult
extends Object
implements Serializable, DebugDumpable

Result of a correlation operation. TODO find a better name

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompleteCorrelationResult.Status

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
String	debugDump(int indent)
static CompleteCorrelationResult	error(@NotNull Throwable t)
static CompleteCorrelationResult	existingOwner(@NotNull ObjectType owner, @Nullable CandidateOwnersMap candidateOwnersMap, @Nullable ResourceObjectOwnerOptionsType optionsBean)
<F extends ObjectType> @NotNull List<F>	getAllCandidates(@NotNull Class<F> focusType)	Returns all candidates of given type.
@Nullable CandidateOwnersMap	getCandidateOwnersMap()
@Nullable String	getErrorMessage()
@Nullable ObjectType	getOwner()
@Nullable ResourceObjectOwnerOptionsType	getOwnerOptions()
@NotNull CorrelationSituationType	getSituation()
boolean	isDone()
boolean	isError()
boolean	isExistingOwner()
boolean	isNoOwner()
boolean	isUncertain()
static CompleteCorrelationResult	noOwner()
void	throwCommonOrRuntimeExceptionIfPresent()	Throws a CommonException or a RuntimeException, if the state is "error".
String	toString()
static CompleteCorrelationResult	uncertain(@NotNull CandidateOwnersMap candidateOwnersMap, @NotNull ResourceObjectOwnerOptionsType optionsBean)

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

existingOwner

public static CompleteCorrelationResult existingOwner(@NotNull
                                                      @NotNull ObjectType owner,
                                                      @Nullable
                                                      @Nullable CandidateOwnersMap candidateOwnersMap,
                                                      @Nullable
                                                      @Nullable ResourceObjectOwnerOptionsType optionsBean)

noOwner

public static CompleteCorrelationResult noOwner()

uncertain

public static CompleteCorrelationResult uncertain(@NotNull
                                                  @NotNull CandidateOwnersMap candidateOwnersMap,
                                                  @NotNull
                                                  @NotNull ResourceObjectOwnerOptionsType optionsBean)

error

public static CompleteCorrelationResult error(@NotNull
                                              @NotNull Throwable t)

getSituation

@NotNull
public @NotNull CorrelationSituationType getSituation()

getOwner

@Nullable
public @Nullable ObjectType getOwner()

getCandidateOwnersMap

@Nullable
public @Nullable CandidateOwnersMap getCandidateOwnersMap()

getOwnerOptions

@Nullable
public @Nullable ResourceObjectOwnerOptionsType getOwnerOptions()

isUncertain

public boolean isUncertain()

isError

public boolean isError()

isExistingOwner

public boolean isExistingOwner()

isNoOwner

public boolean isNoOwner()

isDone

public boolean isDone()

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

toString

public String toString()

Overrides:

toString in class Object

throwCommonOrRuntimeExceptionIfPresent

public void throwCommonOrRuntimeExceptionIfPresent()
                                            throws CommonException

Throws a CommonException or a RuntimeException, if the state is "error". Normally returns otherwise.

Throws:

CommonException

getErrorMessage

@Nullable
public @Nullable String getErrorMessage()

getAllCandidates

@Experimental
@NotNull
public <F extends ObjectType> @NotNull List<F> getAllCandidates(@NotNull
                                                                @NotNull Class<F> focusType)

Returns all candidates of given type. Not supported if the result is taken from the shadow.