Package com.veeva.vault.sdk.api.workflow

Interface WorkflowTaskService

All Superinterfaces:

Service

public interface WorkflowTaskService
extends Service

Provides methods to retrieve and perform updates for tasks of an active workflow.

Method Summary

Modifier and Type	Method	Description
void	cancel(WorkflowInstance workflowInstance, List<WorkflowTaskInstance> taskInstances)	Cancels the given task instances.
List<WorkflowTaskInstance>	getTaskInstances(WorkflowInstance workflowInstance, WorkflowTaskQueryParameters queryParameters)	Retrieves task instances for a workflow instance.
WorkflowTaskQueryParameters	newWorkflowTaskQueryParameters()	Creates a new WorkflowTaskQueryParameters to filter tasks by.

Method Details

getTaskInstances

List<WorkflowTaskInstance> getTaskInstances(WorkflowInstance workflowInstance,
 WorkflowTaskQueryParameters queryParameters)

Retrieves task instances for a workflow instance.

Parameters:

workflowInstance - the WorkflowInstance to retrieve task instances for

queryParameters - optional, the WorkflowTaskQueryParameters to filter tasks by. If omitted, returns all existing task instances for this workflow instance.

Returns:

a List of task instances

cancel

void cancel(WorkflowInstance workflowInstance,
 List<WorkflowTaskInstance> taskInstances)

Cancels the given task instances.

Parameters:

workflowInstance - the WorkflowInstance to cancel task instances for

taskInstances - the collection of WorkflowTaskInstance to cancel

newWorkflowTaskQueryParameters

WorkflowTaskQueryParameters newWorkflowTaskQueryParameters()

Creates a new WorkflowTaskQueryParameters to filter tasks by.

Returns:

WorkflowTaskQueryParameters object