Package com.evolveum.midpoint.model.api

Interface CaseService

All Known Implementing Classes:

ModelController

public interface CaseService

Manipulation of work items and cases at the model API level.

Method Summary

Modifier and Type	Method	Description
void	cancelCase(@NotNull String caseOid, @NotNull Task task, @NotNull OperationResult parentResult)	Cancels a case.
void	claimWorkItem(@NotNull WorkItemId workItemId, @NotNull Task task, @NotNull OperationResult parentResult)	Claims a work item that is assigned to an abstract role, so it becomes assigned to the current princial.
void	completeWorkItem(@NotNull WorkItemId workItemId, @NotNull AbstractWorkItemOutputType output, @NotNull Task task, @NotNull OperationResult parentResult)	Completes a work item (e.g.
void	completeWorkItem(@NotNull WorkItemId workItemId, @NotNull AbstractWorkItemOutputType output, @Nullable ObjectDelta<?> additionalDelta, @NotNull Task task, @NotNull OperationResult parentResult)	Completes a work item.
void	delegateWorkItem(@NotNull WorkItemId workItemId, @NotNull WorkItemDelegationRequestType delegationRequest, @NotNull Task task, @NotNull OperationResult parentResult)	Delegates a work item.
void	releaseWorkItem(@NotNull WorkItemId workItemId, @NotNull Task task, @NotNull OperationResult parentResult)	Releases claimed work item.

Method Detail

completeWorkItem

void completeWorkItem(@NotNull
                      @NotNull WorkItemId workItemId,
                      @NotNull
                      @NotNull AbstractWorkItemOutputType output,
                      @NotNull
                      @NotNull Task task,
                      @NotNull
                      @NotNull OperationResult parentResult)
               throws SecurityViolationException,
                      SchemaException,
                      ObjectNotFoundException,
                      CommunicationException,
                      ConfigurationException,
                      ExpressionEvaluationException,
                      ObjectAlreadyExistsException,
                      PolicyViolationException

Completes a work item (e.g. approves/rejects it if it belongs to an approval case).

Throws:

SecurityViolationException

SchemaException

ObjectNotFoundException

CommunicationException

ConfigurationException

ExpressionEvaluationException

ObjectAlreadyExistsException

PolicyViolationException

completeWorkItem

void completeWorkItem(@NotNull
                      @NotNull WorkItemId workItemId,
                      @NotNull
                      @NotNull AbstractWorkItemOutputType output,
                      @Nullable
                      @Nullable ObjectDelta<?> additionalDelta,
                      @NotNull
                      @NotNull Task task,
                      @NotNull
                      @NotNull OperationResult parentResult)
               throws SecurityViolationException,
                      SchemaException,
                      ObjectNotFoundException,
                      ExpressionEvaluationException,
                      CommunicationException,
                      ConfigurationException

Completes a work item. For approvals only: Additional delta is here present in "prism" form (not as ObjectDeltaType), to simplify the life for clients. It is applied only if the output signals that work item is approved.

Throws:

SecurityViolationException

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

claimWorkItem

void claimWorkItem(@NotNull
                   @NotNull WorkItemId workItemId,
                   @NotNull
                   @NotNull Task task,
                   @NotNull
                   @NotNull OperationResult parentResult)
            throws SecurityViolationException,
                   ObjectNotFoundException,
                   SchemaException,
                   ObjectAlreadyExistsException,
                   CommunicationException,
                   ConfigurationException,
                   ExpressionEvaluationException

Claims a work item that is assigned to an abstract role, so it becomes assigned to the current princial.

Throws:

SecurityViolationException

ObjectNotFoundException

SchemaException

ObjectAlreadyExistsException

CommunicationException

ConfigurationException

ExpressionEvaluationException

releaseWorkItem

void releaseWorkItem(@NotNull
                     @NotNull WorkItemId workItemId,
                     @NotNull
                     @NotNull Task task,
                     @NotNull
                     @NotNull OperationResult parentResult)
              throws ObjectNotFoundException,
                     SecurityViolationException,
                     SchemaException,
                     ObjectAlreadyExistsException,
                     CommunicationException,
                     ConfigurationException,
                     ExpressionEvaluationException

Releases claimed work item.

Throws:

ObjectNotFoundException

SecurityViolationException

SchemaException

ObjectAlreadyExistsException

CommunicationException

ConfigurationException

ExpressionEvaluationException

delegateWorkItem

void delegateWorkItem(@NotNull
                      @NotNull WorkItemId workItemId,
                      @NotNull
                      @NotNull WorkItemDelegationRequestType delegationRequest,
                      @NotNull
                      @NotNull Task task,
                      @NotNull
                      @NotNull OperationResult parentResult)
               throws ObjectNotFoundException,
                      SecurityViolationException,
                      SchemaException,
                      ExpressionEvaluationException,
                      CommunicationException,
                      ConfigurationException

Delegates a work item.

Throws:

ObjectNotFoundException

SecurityViolationException

SchemaException

ExpressionEvaluationException

CommunicationException

ConfigurationException

cancelCase

void cancelCase(@NotNull
                @NotNull String caseOid,
                @NotNull
                @NotNull Task task,
                @NotNull
                @NotNull OperationResult parentResult)
         throws SchemaException,
                ObjectNotFoundException,
                SecurityViolationException,
                ExpressionEvaluationException,
                CommunicationException,
                ConfigurationException,
                ObjectAlreadyExistsException

Cancels a case. The case should be in `created` or `open` state.

Throws:

SchemaException

ObjectNotFoundException

SecurityViolationException

ExpressionEvaluationException

CommunicationException

ConfigurationException

ObjectAlreadyExistsException