Package com.evolveum.midpoint.wf.api

Interface ApprovalsManager

public interface ApprovalsManager

Provides functionality that deals with the approval cases. ("Manager" is probably too strong a work for this, though.)

Method Summary

Modifier and Type	Method	Description
ApprovalSchemaExecutionInformationType	getApprovalSchemaExecutionInformation(@NotNull String caseOid, @NotNull Task task, @NotNull OperationResult result)	Retrieves information about actual or expected execution of an approval schema.
List<ApprovalSchemaExecutionInformationType>	getApprovalSchemaPreview(@NotNull ModelContext<?> modelContext, @NotNull Task task, @NotNull OperationResult result)	Retrieves information about expected approval schema and its execution.
ChangesByState<?>	getChangesByState(CaseType rootCase, ModelInteractionService modelInteractionService, PrismContext prismContext, Task task, OperationResult result)	TODO
ChangesByState<?>	getChangesByState(CaseType approvalCase, CaseType rootCase, ModelInteractionService modelInteractionService, PrismContext prismContext, OperationResult result)	TODO

Method Detail

getApprovalSchemaExecutionInformation

ApprovalSchemaExecutionInformationType getApprovalSchemaExecutionInformation(@NotNull
                                                                             @NotNull String caseOid,
                                                                             @NotNull
                                                                             @NotNull Task task,
                                                                             @NotNull
                                                                             @NotNull OperationResult result)
                                                                      throws SchemaException,
                                                                             ConfigurationException,
                                                                             ObjectNotFoundException,
                                                                             CommunicationException,
                                                                             SecurityViolationException,
                                                                             ExpressionEvaluationException

Retrieves information about actual or expected execution of an approval schema. (So, this is restricted to approvals using this mechanism.) Does not need authorization checks before execution; it uses model calls in order to gather any information needed.

Parameters:

caseOid - OID of an approval case that should be analyzed

task - task under which this operation is carried out

result - operation result

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

SecurityViolationException

ExpressionEvaluationException

getApprovalSchemaPreview

List<ApprovalSchemaExecutionInformationType> getApprovalSchemaPreview(@NotNull
                                                                      @NotNull ModelContext<?> modelContext,
                                                                      @NotNull
                                                                      @NotNull Task task,
                                                                      @NotNull
                                                                      @NotNull OperationResult result)
                                                               throws SchemaException,
                                                                      ConfigurationException,
                                                                      ObjectNotFoundException,
                                                                      CommunicationException,
                                                                      SecurityViolationException,
                                                                      ExpressionEvaluationException

Retrieves information about expected approval schema and its execution. (So, this is restricted to approvals using this mechanism.) Does not need authorization checks before execution; it uses model calls in order to gather any information needed.

Parameters:

modelContext - model context with the projector run already carried out (so the policy rules are evaluated)

task - task under which this operation is carried out

result - operation result

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

SecurityViolationException

ExpressionEvaluationException

getChangesByState

ChangesByState<?> getChangesByState(CaseType rootCase,
                                    ModelInteractionService modelInteractionService,
                                    PrismContext prismContext,
                                    Task task,
                                    OperationResult result)
                             throws SchemaException,
                                    ObjectNotFoundException

TODO

Throws:

SchemaException

ObjectNotFoundException

getChangesByState

ChangesByState<?> getChangesByState(CaseType approvalCase,
                                    CaseType rootCase,
                                    ModelInteractionService modelInteractionService,
                                    PrismContext prismContext,
                                    OperationResult result)
                             throws SchemaException,
                                    ObjectNotFoundException

TODO

Throws:

SchemaException

ObjectNotFoundException