Package com.evolveum.midpoint.wf.api

Interface WorkflowManager

public interface WorkflowManager

TODO specify and clean-up error handling

Author:

mederly

Method Summary

Modifier and Type	Method	Description
void	cancelCase(String caseOid, Task task, OperationResult parentResult)
void	claimWorkItem(WorkItemId workItemId, Task task, OperationResult result)
void	completeWorkItem(WorkItemId workItemId, AbstractWorkItemOutputType output, WorkItemEventCauseInformationType causeInformation, Task task, OperationResult parentResult)	Approves or rejects a work item
PerformerCommentsFormatter	createPerformerCommentsFormatter(PerformerCommentsFormattingType formatting)
void	delegateWorkItem(WorkItemId workItemId, WorkItemDelegationRequestType delegationRequest, Task task, OperationResult parentResult)
ApprovalSchemaExecutionInformationType	getApprovalSchemaExecutionInformation(String taskOid, Task opTask, OperationResult parentResult)	Retrieves information about actual or expected execution of an approval schema.
List<ApprovalSchemaExecutionInformationType>	getApprovalSchemaPreview(ModelContext<?> modelContext, Task opTask, OperationResult parentResult)	Retrieves information about expected approval schema and its execution.
ChangesByState	getChangesByState(CaseType rootCase, ModelInteractionService modelInteractionService, PrismContext prismContext, Task task, OperationResult result)
ChangesByState	getChangesByState(CaseType approvalCase, CaseType rootCase, ModelInteractionService modelInteractionService, PrismContext prismContext, OperationResult result)
PrismContext	getPrismContext()
boolean	isCurrentUserAuthorizedToClaim(CaseWorkItemType workItem)
boolean	isCurrentUserAuthorizedToDelegate(CaseWorkItemType workItem, Task task, OperationResult result)
boolean	isCurrentUserAuthorizedToSubmit(CaseWorkItemType workItem, Task task, OperationResult result)
boolean	isEnabled()
void	registerWorkflowListener(WorkflowListener workflowListener)
void	releaseWorkItem(WorkItemId workItemId, Task task, OperationResult result)

Method Detail

completeWorkItem

void completeWorkItem(WorkItemId workItemId,
                      AbstractWorkItemOutputType output,
                      WorkItemEventCauseInformationType causeInformation,
                      Task task,
                      OperationResult parentResult)
               throws SecurityViolationException,
                      SchemaException,
                      ObjectNotFoundException,
                      ExpressionEvaluationException,
                      CommunicationException,
                      ConfigurationException

Approves or rejects a work item

Parameters:

decision - true = approve, false = reject

Throws:

SecurityViolationException

SchemaException

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

claimWorkItem

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

Throws:

ObjectNotFoundException

SecurityViolationException

SchemaException

ObjectAlreadyExistsException

CommunicationException

ConfigurationException

ExpressionEvaluationException

releaseWorkItem

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

Throws:

SecurityViolationException

ObjectNotFoundException

SchemaException

ObjectAlreadyExistsException

CommunicationException

ConfigurationException

ExpressionEvaluationException

delegateWorkItem

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

Throws:

SecurityViolationException

ObjectNotFoundException

SchemaException

ExpressionEvaluationException

CommunicationException

ConfigurationException

cancelCase

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

Throws:

SchemaException

ObjectNotFoundException

ObjectAlreadyExistsException

SecurityViolationException

CommunicationException

ConfigurationException

ExpressionEvaluationException

isEnabled

boolean isEnabled()

getPrismContext

PrismContext getPrismContext()

registerWorkflowListener

void registerWorkflowListener(WorkflowListener workflowListener)

isCurrentUserAuthorizedToSubmit

boolean isCurrentUserAuthorizedToSubmit(CaseWorkItemType workItem,
                                        Task task,
                                        OperationResult result)
                                 throws ObjectNotFoundException,
                                        ExpressionEvaluationException,
                                        CommunicationException,
                                        ConfigurationException,
                                        SecurityViolationException

Throws:

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

SecurityViolationException

isCurrentUserAuthorizedToClaim

boolean isCurrentUserAuthorizedToClaim(CaseWorkItemType workItem)

isCurrentUserAuthorizedToDelegate

boolean isCurrentUserAuthorizedToDelegate(CaseWorkItemType workItem,
                                          Task task,
                                          OperationResult result)
                                   throws ObjectNotFoundException,
                                          ExpressionEvaluationException,
                                          CommunicationException,
                                          ConfigurationException,
                                          SecurityViolationException

Throws:

ObjectNotFoundException

ExpressionEvaluationException

CommunicationException

ConfigurationException

SecurityViolationException

getChangesByState

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

Throws:

SchemaException

ObjectNotFoundException

getChangesByState

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

Throws:

SchemaException

ObjectNotFoundException

getApprovalSchemaExecutionInformation

ApprovalSchemaExecutionInformationType getApprovalSchemaExecutionInformation(String taskOid,
                                                                             Task opTask,
                                                                             OperationResult parentResult)
                                                                      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:

taskOid - OID of an approval task that should be analyzed

opTask - task under which this operation is carried out

parentResult - operation result

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

SecurityViolationException

ExpressionEvaluationException

getApprovalSchemaPreview

List<ApprovalSchemaExecutionInformationType> getApprovalSchemaPreview(ModelContext<?> modelContext,
                                                                      Task opTask,
                                                                      OperationResult parentResult)
                                                               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)

opTask - task under which this operation is carried out

parentResult - operation result

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

SecurityViolationException

ExpressionEvaluationException

createPerformerCommentsFormatter

PerformerCommentsFormatter createPerformerCommentsFormatter(PerformerCommentsFormattingType formatting)