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

Interface CorrelationService

public interface CorrelationService

Contains correlation-related methods that should be accessible from the outside of `model` module.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CorrelationService.CaseCloser
static class	CorrelationService.CorrelationCaseDescriptionOptions	Options for describeCorrelationCase(CaseType, CorrelationCaseDescriptionOptions, Task, OperationResult) method.

Method Summary

Modifier and Type	Method	Description
void	completeCorrelationCase(@NotNull CaseType currentCase, @NotNull CorrelationService.CaseCloser caseCloser, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult result)	Completes given correlation case.
@NotNull CorrelationCaseDescription<?>	describeCorrelationCase(@NotNull CaseType aCase, @Nullable CorrelationService.CorrelationCaseDescriptionOptions options, @NotNull com.evolveum.midpoint.task.api.Task task, @NotNull OperationResult result)	Describes the provided correlation case by providing CorrelationCaseDescription object.

Method Detail

describeCorrelationCase

@NotNull
@NotNull CorrelationCaseDescription<?> describeCorrelationCase(@NotNull
                                                               @NotNull CaseType aCase,
                                                               @Nullable
                                                               @Nullable CorrelationService.CorrelationCaseDescriptionOptions options,
                                                               @NotNull
                                                               @NotNull com.evolveum.midpoint.task.api.Task task,
                                                               @NotNull
                                                               @NotNull OperationResult result)
                                                        throws SchemaException,
                                                               ConfigurationException,
                                                               ExpressionEvaluationException,
                                                               CommunicationException,
                                                               SecurityViolationException,
                                                               ObjectNotFoundException

Describes the provided correlation case by providing CorrelationCaseDescription object. Currently, it . takes the shadow stored in the correlation case (i.e. does NOT fetch it anew), . recomputes inbound mappings (i.e. ignores stored pre-focus), . and processes candidate owners stored in the correlation case (i.e. does NOT search for them again). The CorrelationService.CorrelationCaseDescriptionOptions parameter signals if the client wishes to provide also the correlation explanation, or not. (In the future, we may provide options also for behavior in points 1-3 mentioned above.)

Throws:

SchemaException

ConfigurationException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ObjectNotFoundException

completeCorrelationCase

void completeCorrelationCase(@NotNull
                             @NotNull CaseType currentCase,
                             @NotNull
                             @NotNull CorrelationService.CaseCloser caseCloser,
                             @NotNull
                             @NotNull com.evolveum.midpoint.task.api.Task task,
                             @NotNull
                             @NotNull OperationResult result)
                      throws SchemaException,
                             ExpressionEvaluationException,
                             CommunicationException,
                             SecurityViolationException,
                             ConfigurationException,
                             ObjectNotFoundException

Completes given correlation case. Preconditions: - case is freshly fetched, - case is a correlation one

Parameters:

caseCloser - Makes the case definitely closed. (This functionality must be provided by the caller.)

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

ObjectNotFoundException