com.evolveum.midpoint.model.api

Interface WorkflowService

public interface WorkflowService

Author:

mederly

Method Summary

Methods

Modifier and Type	Method and Description
void	approveOrRejectWorkItem(String workItemId, boolean decision, OperationResult parentResult) Approves or rejects a work item (without supplying any further information).
void	approveOrRejectWorkItemWithDetails(String workItemId, com.evolveum.midpoint.prism.PrismObject specific, boolean decision, OperationResult result)
void	claimWorkItem(String workItemId, OperationResult parentResult)
void	completeWorkItemWithDetails(String workItemId, com.evolveum.midpoint.prism.PrismObject specific, String decision, OperationResult parentResult)
int	countProcessInstancesRelatedToUser(String userOid, boolean requestedBy, boolean requestedFor, boolean finished, OperationResult parentResult)
int	countWorkItemsRelatedToUser(String userOid, boolean assigned, OperationResult parentResult) Counts Work Items related to a user.
void	deleteProcessInstance(String instanceId, OperationResult parentResult)
WfProcessInstanceType	getProcessInstanceById(String instanceId, boolean historic, boolean getWorkItems, OperationResult parentResult) Returns information about a process instance.
WfProcessInstanceType	getProcessInstanceByWorkItemId(String workItemId, OperationResult parentResult)
WorkItemType	getWorkItemDetailsById(String workItemId, OperationResult parentResult) Provides detailed information about a given work item (may be inefficient, so use with care).
List<WfProcessInstanceType>	listProcessInstancesRelatedToUser(String userOid, boolean requestedBy, boolean requestedFor, boolean finished, int first, int count, OperationResult parentResult)
List<WorkItemType>	listWorkItemsRelatedToUser(String userOid, boolean assigned, int first, int count, OperationResult parentResult) Lists work items related to a user.
void	releaseWorkItem(String workItemId, OperationResult parentResult)
void	stopProcessInstance(String instanceId, String username, OperationResult parentResult)

Method Detail

countWorkItemsRelatedToUser

int countWorkItemsRelatedToUser(String userOid,
                              boolean assigned,
                              OperationResult parentResult)
                                throws SchemaException,
                                       ObjectNotFoundException

Counts Work Items related to a user.

Parameters:

userOid - OID of the user

assigned - whether to count assigned (true) or assignable (false) work items

parentResult -

Returns:

number of relevant work items

Throws:

SchemaException

ObjectNotFoundException

listWorkItemsRelatedToUser

List<WorkItemType> listWorkItemsRelatedToUser(String userOid,
                                            boolean assigned,
                                            int first,
                                            int count,
                                            OperationResult parentResult)
                                              throws SchemaException,
                                                     ObjectNotFoundException

Lists work items related to a user.

Parameters:

userOid - OID of the user

assigned - whether to count assigned (true) or assignable (false) work items

first -

count -

parentResult -

Returns:

list of work items

Throws:

SchemaException

ObjectNotFoundException

getWorkItemDetailsById

WorkItemType getWorkItemDetailsById(String workItemId,
                                  OperationResult parentResult)
                                    throws ObjectNotFoundException

Provides detailed information about a given work item (may be inefficient, so use with care).

Parameters:

taskId -

parentResult -

Returns:

Throws:

ObjectNotFoundException

WorkflowException

countProcessInstancesRelatedToUser

int countProcessInstancesRelatedToUser(String userOid,
                                     boolean requestedBy,
                                     boolean requestedFor,
                                     boolean finished,
                                     OperationResult parentResult)

listProcessInstancesRelatedToUser

List<WfProcessInstanceType> listProcessInstancesRelatedToUser(String userOid,
                                                            boolean requestedBy,
                                                            boolean requestedFor,
                                                            boolean finished,
                                                            int first,
                                                            int count,
                                                            OperationResult parentResult)

getProcessInstanceByWorkItemId

WfProcessInstanceType getProcessInstanceByWorkItemId(String workItemId,
                                                   OperationResult parentResult)
                                                     throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getProcessInstanceById

WfProcessInstanceType getProcessInstanceById(String instanceId,
                                           boolean historic,
                                           boolean getWorkItems,
                                           OperationResult parentResult)
                                             throws ObjectNotFoundException

Returns information about a process instance. WorkItems attribute is filled-in only upon request! (see getWorkItems parameter)

Parameters:

instanceId -

historic -

getWorkItems -

parentResult -

Returns:

Throws:

ObjectNotFoundException

WorkflowException

approveOrRejectWorkItem

void approveOrRejectWorkItem(String workItemId,
                           boolean decision,
                           OperationResult parentResult)

Approves or rejects a work item (without supplying any further information).

Parameters:

taskId - identifier of activiti task backing the work item

decision - true = approve, false = reject

parentResult -

approveOrRejectWorkItemWithDetails

void approveOrRejectWorkItemWithDetails(String workItemId,
                                      com.evolveum.midpoint.prism.PrismObject specific,
                                      boolean decision,
                                      OperationResult result)

completeWorkItemWithDetails

void completeWorkItemWithDetails(String workItemId,
                               com.evolveum.midpoint.prism.PrismObject specific,
                               String decision,
                               OperationResult parentResult)

stopProcessInstance

void stopProcessInstance(String instanceId,
                       String username,
                       OperationResult parentResult)

deleteProcessInstance

void deleteProcessInstance(String instanceId,
                         OperationResult parentResult)

claimWorkItem

void claimWorkItem(String workItemId,
                 OperationResult parentResult)

releaseWorkItem

void releaseWorkItem(String workItemId,
                   OperationResult parentResult)