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
WorkflowTaskAssignOperation	assign(WorkflowTaskAssignRequest request)	Creates a WorkflowTaskAssignOperation, which can be used to assign an active, available task based on the provided WorkflowTaskAssignRequest.
void	cancel(WorkflowInstance workflowInstance, List<WorkflowTaskInstance> taskInstances)	Deprecated. as of 24R3.4, replaced by cancel(WorkflowTaskCancelRequest)
WorkflowTaskCancelOperation	cancel(WorkflowTaskCancelRequest request)	Creates a WorkflowTaskCancelOperation, which can be used to cancel an active, assigned task based on the provided WorkflowTaskCancelRequest.
WorkflowTaskCompleteOperation<WorkflowTaskCompleteResponse>	completeTask(WorkflowTaskCompleteRequest request)	Creates a WorkflowTaskCompleteOperation, which can be used to complete an active, assigned task based on the provided WorkflowTaskCompleteRequest.
AvailableWorkflowTaskActionsResponse	getAvailableWorkflowTaskActions(AvailableWorkflowTaskActionsRequest request)	Retrieves the available workflow task actions for the provided workflow task.
List<WorkflowTaskInstance>	getTaskInstances(WorkflowInstance workflowInstance, WorkflowTaskQueryParameters queryParameters)	Retrieves task instances for a workflow instance.
AvailableWorkflowTaskActionsRequest.Builder	newAvailableWorkflowTaskActionsRequestBuilder()	Creates a AvailableWorkflowTaskActionsRequest.Builder.
WorkflowTaskAssignRequest.Builder	newWorkflowTaskAssignRequestBuilder()	Creates a WorkflowTaskAssignRequest.Builder.
WorkflowTaskCancelRequest.Builder	newWorkflowTaskCancelRequestBuilder()	Creates a WorkflowTaskCancelRequest.Builder.
WorkflowTaskCompleteRequest.Builder	newWorkflowTaskCompleteRequestBuilder()	Creates a WorkflowTaskCompleteRequest.Builder.
WorkflowTaskInput.Builder	newWorkflowTaskInputBuilder()	Creates a WorkflowTaskInput.Builder.
WorkflowTaskItemVerdictInput.Builder	newWorkflowTaskItemVerdictInputBuilder()	Creates a WorkflowTaskItemVerdictInput.Builder.
WorkflowTaskQueryParameters	newWorkflowTaskQueryParameters()	Creates a new WorkflowTaskQueryParameters to filter tasks by.
WorkflowTaskReassignRequest.Builder	newWorkflowTaskReassignRequestBuilder()	Creates a WorkflowTaskReassignRequest.Builder.
WorkflowTaskSetItemVerdictRequest.Builder	newWorkflowTaskSetItemVerdictRequestBuilder()	Creates a WorkflowTaskSetItemVerdictRequest.Builder.
WorkflowTaskUnassignRequest.Builder	newWorkflowTaskUnassignRequestBuilder()	Creates a WorkflowTaskUnassignRequest.Builder.
WorkflowTaskUpdateDueDateRequest.Builder	newWorkflowTaskUpdateDueDateRequestBuilder()	Creates a WorkflowTaskUpdateDueDateRequest.Builder.
WorkflowTaskReassignOperation	reassign(WorkflowTaskReassignRequest request)	Creates a WorkflowTaskReassignOperation, which can be used to reassign an active, assigned task based on the provided WorkflowTaskReassignRequest.
WorkflowTaskCompleteOperation<WorkflowTaskSetItemVerdictResponse>	setItemVerdict(WorkflowTaskSetItemVerdictRequest request)	Creates a WorkflowTaskCompleteOperation, which can be used to set verdicts for items in an active, assigned task based on the provided WorkflowTaskSetItemVerdictRequest.
WorkflowTaskUnassignOperation	unassign(WorkflowTaskUnassignRequest request)	Creates a WorkflowTaskUnassignOperation, which can be used to unassign an active, assigned task based on the provided WorkflowTaskUnassignRequest.
WorkflowTaskUpdateDueDateOperation	updateDueDate(WorkflowTaskUpdateDueDateRequest request)	Creates a WorkflowTaskUpdateDueDateOperation, which can be used to update the due date for an active, assigned task based on the provided WorkflowTaskUpdateDueDateRequest.

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

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

Deprecated.

as of 24R3.4, replaced by cancel(WorkflowTaskCancelRequest)

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

newAvailableWorkflowTaskActionsRequestBuilder

AvailableWorkflowTaskActionsRequest.Builder newAvailableWorkflowTaskActionsRequestBuilder()

Creates a AvailableWorkflowTaskActionsRequest.Builder.

Returns:

a AvailableWorkflowTaskActionsRequest.Builder

getAvailableWorkflowTaskActions

AvailableWorkflowTaskActionsResponse getAvailableWorkflowTaskActions(AvailableWorkflowTaskActionsRequest request)

Retrieves the available workflow task actions for the provided workflow task.

Parameters:

request - the AvailableWorkflowTaskActionsRequest containing the information needed to retrieve the available actions for the workflow task. Requires workflow task ID.

Returns:

an AvailableWorkflowTaskActionsResponse containing the available workflow task actions

newWorkflowTaskAssignRequestBuilder

WorkflowTaskAssignRequest.Builder newWorkflowTaskAssignRequestBuilder()

Creates a WorkflowTaskAssignRequest.Builder.

Returns:

a WorkflowTaskAssignRequest.Builder

assign

WorkflowTaskAssignOperation assign(WorkflowTaskAssignRequest request)

Creates a WorkflowTaskAssignOperation, which can be used to assign an active, available task based on the provided WorkflowTaskAssignRequest. Use WorkflowTaskAssignOperation.execute() to assign a task. For example:

 workflowTaskService.assign(workflowTaskAssignRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

Parameters:

request - the WorkflowTaskAssignRequest containing the information needed to assign the task. Requires an active, available task. Cannot be null.

Returns:

a WorkflowTaskAssignOperation, which can be used to assign the task

newWorkflowTaskUnassignRequestBuilder

WorkflowTaskUnassignRequest.Builder newWorkflowTaskUnassignRequestBuilder()

Creates a WorkflowTaskUnassignRequest.Builder.

Returns:

a WorkflowTaskUnassignRequest.Builder

unassign

WorkflowTaskUnassignOperation unassign(WorkflowTaskUnassignRequest request)

Creates a WorkflowTaskUnassignOperation, which can be used to unassign an active, assigned task based on the provided WorkflowTaskUnassignRequest. Use WorkflowTaskUnassignOperation.execute() to unassign a task. For example:

 workflowTaskService.unassign(workflowTaskUnassignRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

Parameters:

request - the WorkflowTaskUnassignRequest containing the information needed to unassign the task. Requires an active task. Cannot be null.

Returns:

a WorkflowTaskUnassignOperation, which can be used to unassign the task

newWorkflowTaskCancelRequestBuilder

WorkflowTaskCancelRequest.Builder newWorkflowTaskCancelRequestBuilder()

Creates a WorkflowTaskCancelRequest.Builder.

Returns:

a WorkflowTaskCancelRequest.Builder

cancel

WorkflowTaskCancelOperation cancel(WorkflowTaskCancelRequest request)

Creates a WorkflowTaskCancelOperation, which can be used to cancel an active, assigned task based on the provided WorkflowTaskCancelRequest. Use WorkflowTaskCancelOperation.execute() to cancel a task. For example:

 workflowTaskService.cancel(workflowTaskCancelRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

Parameters:

request - the WorkflowTaskCancelRequest containing the information needed to cancel the task. Requires an active task. Cannot be null.

Returns:

a WorkflowTaskCancelOperation, which can be used to cancel the task

newWorkflowTaskReassignRequestBuilder

WorkflowTaskReassignRequest.Builder newWorkflowTaskReassignRequestBuilder()

Creates a WorkflowTaskReassignRequest.Builder.

Returns:

a WorkflowTaskReassignRequest.Builder

reassign

WorkflowTaskReassignOperation reassign(WorkflowTaskReassignRequest request)

Creates a WorkflowTaskReassignOperation, which can be used to reassign an active, assigned task based on the provided WorkflowTaskReassignRequest. Use WorkflowTaskReassignOperation.execute() to reassign a task. For example:

 workflowTaskService.reassign(workflowTaskReassignRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

Parameters:

request - the WorkflowTaskReassignRequest containing the information needed to reassign the task. Requires an active, assigned task. Cannot be null.

Returns:

a WorkflowTaskReassignOperation, which can be used to reassign the task

newWorkflowTaskUpdateDueDateRequestBuilder

WorkflowTaskUpdateDueDateRequest.Builder newWorkflowTaskUpdateDueDateRequestBuilder()

Creates a WorkflowTaskUpdateDueDateRequest.Builder.

Returns:

a WorkflowTaskUpdateDueDateRequest.Builder

updateDueDate

WorkflowTaskUpdateDueDateOperation updateDueDate(WorkflowTaskUpdateDueDateRequest request)

Creates a WorkflowTaskUpdateDueDateOperation, which can be used to update the due date for an active, assigned task based on the provided WorkflowTaskUpdateDueDateRequest. Use WorkflowTaskUpdateDueDateOperation.execute() to update the due date for a task. For example:

 workflowTaskService.updateDueDate(workflowTaskUpdateDueDateRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

Parameters:

request - the WorkflowTaskUpdateDueDateRequest containing the information needed to update the task due date. Requires an active task. Cannot be null.

Returns:

a WorkflowTaskUpdateDueDateOperation, which can be used to update the task due date

newWorkflowTaskCompleteRequestBuilder

WorkflowTaskCompleteRequest.Builder newWorkflowTaskCompleteRequestBuilder()

Creates a WorkflowTaskCompleteRequest.Builder.

Returns:

a WorkflowTaskCompleteRequest.Builder

newWorkflowTaskInputBuilder

WorkflowTaskInput.Builder newWorkflowTaskInputBuilder()

Creates a WorkflowTaskInput.Builder.

Returns:

a WorkflowTaskInput.Builder

newWorkflowTaskItemVerdictInputBuilder

WorkflowTaskItemVerdictInput.Builder newWorkflowTaskItemVerdictInputBuilder()

Creates a WorkflowTaskItemVerdictInput.Builder.

Returns:

a WorkflowTaskItemVerdictInput.Builder

newWorkflowTaskSetItemVerdictRequestBuilder

WorkflowTaskSetItemVerdictRequest.Builder newWorkflowTaskSetItemVerdictRequestBuilder()

Creates a WorkflowTaskSetItemVerdictRequest.Builder.

Returns:

a WorkflowTaskSetItemVerdictRequest.Builder

completeTask

WorkflowTaskCompleteOperation<WorkflowTaskCompleteResponse> completeTask(WorkflowTaskCompleteRequest request)

Creates a WorkflowTaskCompleteOperation, which can be used to complete an active, assigned task based on the provided WorkflowTaskCompleteRequest. Use WorkflowTaskCompleteOperation.execute() to complete a task.

Parameters:

request - the WorkflowTaskCompleteRequest containing the information needed to complete the task.

Returns:

a WorkflowTaskCompleteOperation, which can be used to complete the task

setItemVerdict

WorkflowTaskCompleteOperation<WorkflowTaskSetItemVerdictResponse> setItemVerdict(WorkflowTaskSetItemVerdictRequest request)

Creates a WorkflowTaskCompleteOperation, which can be used to set verdicts for items in an active, assigned task based on the provided WorkflowTaskSetItemVerdictRequest. Use WorkflowTaskCompleteOperation.execute() to set item verdicts.

Parameters:

request - the WorkflowTaskSetItemVerdictRequest containing the information needed to set item verdicts.

Returns:

a WorkflowTaskCompleteOperation, which can be used to set item verdicts