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

Interface WorkflowInstanceService

All Superinterfaces:

Service

public interface WorkflowInstanceService
extends Service

Provides methods to retrieve information for and update workflow instances.

Method Summary

Modifier and Type	Method	Description
WorkflowAddParticipantsOperation	addParticipants(WorkflowAddParticipantsRequest request)	Creates a WorkflowAddParticipantsOperation, which can be used to add participants to an active workflow based on the provided WorkflowAddParticipantsRequest.
WorkflowCancelOperation	cancelWorkflow(WorkflowCancelRequest request)	Creates a WorkflowCancelOperation, which can be used to cancel an active workflow based on the provided WorkflowCancelRequest.
AvailableWorkflowInstanceActionsResponse	getAvailableWorkflowInstanceActions(WorkflowInstanceRequest request)	Gets the available workflow actions for the provided workflow instance.
WorkflowInstance	getWorkflowInstance(WorkflowInstanceRequest request)	Retrieves a WorkflowInstance on the given workflow ID.
WorkflowInstanceCollectionResponse	getWorkflowInstances(WorkflowInstanceCollectionRequest request)	Retrieves a list of workflow instances on the given search options.
WorkflowItemsResponse	getWorkflowItems(String workflowId)	Retrieves a WorkflowItemsResponse containing the items in the active workflow this action is executing against.
WorkflowParticipantGroupResponse	getWorkflowParticipantGroups(String workflowId)	Retrieves a WorkflowParticipantGroupResponse containing workflow participant groups in the given active workflow.
WorkflowParticipantGroupUpdate	newParticipantGroupUpdate(WorkflowParticipantGroup participantGroup)	Creates a new WorkflowParticipantGroupUpdate to allow membership updates to a participant group.
WorkflowAddParticipantsRequest.Builder	newWorkflowAddParticipantsRequestBuilder()	Creates a WorkflowAddParticipantsRequest.Builder.
WorkflowCancelRequest.Builder	newWorkflowCancelRequestBuilder()	Creates a WorkflowCancelRequest.Builder.
WorkflowInstanceCollectionRequest.Builder	newWorkflowInstanceCollectionRequestBuilder()	Creates an WorkflowInstanceCollectionRequest.Builder.
WorkflowInstanceRequest.Builder	newWorkflowInstanceRequestBuilder()	Creates a WorkflowInstanceRequest.Builder.
WorkflowParticipantGroupInputParameter.Builder	newWorkflowParticipantGroupInputParameterBuilder()	Creates a WorkflowParticipantGroupInputParameter.Builder.
WorkflowParticipantInputParameter.Builder	newWorkflowParticipantInputParameterBuilder()	Creates a WorkflowParticipantInputParameter.Builder.
WorkflowRemoveItemsRequest.Builder	newWorkflowRemoveItemsRequestBuilder()	Creates a WorkflowRemoveItemsRequest.Builder.
WorkflowReplaceOwnerRequest.Builder	newWorkflowReplaceOwnerRequestBuilder()	Creates a WorkflowReplaceOwnerRequest.Builder.
WorkflowStartInstanceRequest.Builder	newWorkflowStartRequestBuilder()	Creates a WorkflowStartInstanceRequest.Builder.
WorkflowUpdateDueDateRequest.Builder	newWorkflowUpdateDueDateRequestBuilder()	Creates a WorkflowUpdateDueDateRequest.Builder.
WorkflowRemoveItemsOperation	removeItems(WorkflowRemoveItemsRequest request)	Creates a WorkflowRemoveItemsOperation, which can be used to remove items in an active workflow based on the provided WorkflowRemoveItemsRequest.
WorkflowReplaceOwnerOperation	replaceWorkflowOwner(WorkflowReplaceOwnerRequest request)	Creates a WorkflowReplaceOwnerOperation, which can be used to replace the owner of an active workflow based on the provided WorkflowReplaceOwnerRequest.
WorkflowStartInstanceOperation<WorkflowStartInstanceResponse>	startWorkflow(WorkflowStartInstanceRequest request)	Starts the workflow with the workflow name, list of document IDs or record IDs, and input parameters.
void	updateParticipantGroup(WorkflowParticipantGroupUpdate participantGroupUpdate)	Updates a specific participant group for a workflow instance.
WorkflowUpdateDueDateOperation	updateWorkflowDueDate(WorkflowUpdateDueDateRequest request)	Creates a WorkflowUpdateDueDateOperation, which can be used to update the due date of an active workflow based on the provided WorkflowUpdateDueDateRequest.

Method Details

newParticipantGroupUpdate

WorkflowParticipantGroupUpdate newParticipantGroupUpdate(WorkflowParticipantGroup participantGroup)

Creates a new WorkflowParticipantGroupUpdate to allow membership updates to a participant group.

Parameters:

participantGroup - the participant group that should be updated

Returns:

WorkflowParticipantGroupUpdate object

updateParticipantGroup

void updateParticipantGroup(WorkflowParticipantGroupUpdate participantGroupUpdate)

Updates a specific participant group for a workflow instance. This method ignores any role restrictions previously configured by the workflow Start step's participant control.

This method cannot update participant groups if the Participants control on the Start step is configured with Use roles as participants, Use user reference field as participants, or Use Vault user group as participants.

Parameters:

participantGroupUpdate - the WorkflowParticipantGroupUpdate containing updated membership for a specific participant group

newWorkflowStartRequestBuilder

WorkflowStartInstanceRequest.Builder newWorkflowStartRequestBuilder()

Creates a WorkflowStartInstanceRequest.Builder.

Returns:

a WorkflowStartInstanceRequest.Builder

newWorkflowParticipantInputParameterBuilder

WorkflowParticipantInputParameter.Builder newWorkflowParticipantInputParameterBuilder()

Creates a WorkflowParticipantInputParameter.Builder.

Returns:

a WorkflowParticipantInputParameter.Builder

startWorkflow

WorkflowStartInstanceOperation<WorkflowStartInstanceResponse> startWorkflow(WorkflowStartInstanceRequest request)

Starts the workflow with the workflow name, list of document IDs or record IDs, and input parameters.

Parameters:

request - the WorkflowStartInstanceRequest containing the information needed to start the workflow. Requires workflow name, list of document or record IDs, and input parameters. Cannot be null.

Returns:

a WorkflowStartInstanceOperation containing a WorkflowStartInstanceResponse with the execution status and workflow ID

newWorkflowInstanceRequestBuilder

WorkflowInstanceRequest.Builder newWorkflowInstanceRequestBuilder()

Creates a WorkflowInstanceRequest.Builder.

Returns:

a WorkflowInstanceRequest.Builder

getWorkflowInstance

WorkflowInstance getWorkflowInstance(WorkflowInstanceRequest request)

Retrieves a WorkflowInstance on the given workflow ID.

Parameters:

request - the WorkflowInstanceRequest containing the information needed to retrieve the workflow instance. Requires workflow id.

Returns:

a WorkflowInstance containing workflow details. Throws a runtime exception if the workflow cannot be found.

newWorkflowInstanceCollectionRequestBuilder

WorkflowInstanceCollectionRequest.Builder newWorkflowInstanceCollectionRequestBuilder()

Creates an WorkflowInstanceCollectionRequest.Builder.

Returns:

an WorkflowInstanceCollectionRequest.Builder

getWorkflowInstances

WorkflowInstanceCollectionResponse getWorkflowInstances(WorkflowInstanceCollectionRequest request)

Retrieves a list of workflow instances on the given search options.

Parameters:

request - the WorkflowInstanceCollectionRequest containing the information needed to retrieve the list of workflow instances. Cannot be null.

Returns:

a WorkflowInstanceCollectionResponse containing the list of workflow instances

getAvailableWorkflowInstanceActions

AvailableWorkflowInstanceActionsResponse getAvailableWorkflowInstanceActions(WorkflowInstanceRequest request)

Gets the available workflow actions for the provided workflow instance.

Parameters:

request - the WorkflowInstanceRequest containing the information needed to retrieve the available actions for the workflow instance. Requires workflow id.

Returns:

a AvailableWorkflowInstanceActionsResponse containing the available workflow actions.

newWorkflowAddParticipantsRequestBuilder

WorkflowAddParticipantsRequest.Builder newWorkflowAddParticipantsRequestBuilder()

Creates a WorkflowAddParticipantsRequest.Builder.

Returns:

a WorkflowAddParticipantsRequest.Builder

newWorkflowParticipantGroupInputParameterBuilder

WorkflowParticipantGroupInputParameter.Builder newWorkflowParticipantGroupInputParameterBuilder()

Creates a WorkflowParticipantGroupInputParameter.Builder.

Returns:

a WorkflowParticipantGroupInputParameter.Builder

addParticipants

WorkflowAddParticipantsOperation addParticipants(WorkflowAddParticipantsRequest request)

Creates a WorkflowAddParticipantsOperation, which can be used to add participants to an active workflow based on the provided WorkflowAddParticipantsRequest. Use WorkflowAddParticipantsOperation.execute() to add participants to the workflow. For example:

 workflowInstanceService.addParticipants(workflowAddParticipantsRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

Parameters:

request - the WorkflowAddParticipantsRequest containing the information needed to add participants to the workflow. Requires an active workflow, participant group name, and a minimum of one user or group IDs.

Returns:

a WorkflowAddParticipantsOperation, which can be used to add participants to the workflow.

newWorkflowCancelRequestBuilder

WorkflowCancelRequest.Builder newWorkflowCancelRequestBuilder()

Creates a WorkflowCancelRequest.Builder.

Returns:

a WorkflowCancelRequest.Builder

cancelWorkflow

WorkflowCancelOperation cancelWorkflow(WorkflowCancelRequest request)

Creates a WorkflowCancelOperation, which can be used to cancel an active workflow based on the provided WorkflowCancelRequest.

Use WorkflowCancelOperation.execute() to cancel the workflow. For example:

 workflowInstanceService.cancelWorkflow(workflowCancelRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

Parameters:

request - the WorkflowCancelRequest containing the information needed to cancel the workflow. Requires an active workflow. Cannot be null.

Returns:

a WorkflowCancelOperation, which can be used to cancel the workflow

newWorkflowRemoveItemsRequestBuilder

WorkflowRemoveItemsRequest.Builder newWorkflowRemoveItemsRequestBuilder()

Creates a WorkflowRemoveItemsRequest.Builder.

Returns:

a WorkflowRemoveItemsRequest.Builder

removeItems

WorkflowRemoveItemsOperation removeItems(WorkflowRemoveItemsRequest request)

Creates a WorkflowRemoveItemsOperation, which can be used to remove items in an active workflow based on the provided WorkflowRemoveItemsRequest. Use WorkflowRemoveItemsOperation.execute() to remove items in the workflow. For example:

 workflowInstanceService.removeItems(workflowRemoveItemsRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

Parameters:

request - the WorkflowRemoveItemsRequest containing the information needed to remove items in the workflow. Requires an active workflow and a list of document or record IDs.

Returns:

a WorkflowRemoveItemsOperation, which can be used to remove items in the workflow.

newWorkflowReplaceOwnerRequestBuilder

WorkflowReplaceOwnerRequest.Builder newWorkflowReplaceOwnerRequestBuilder()

Creates a WorkflowReplaceOwnerRequest.Builder.

Returns:

a WorkflowReplaceOwnerRequest.Builder

replaceWorkflowOwner

WorkflowReplaceOwnerOperation replaceWorkflowOwner(WorkflowReplaceOwnerRequest request)

Creates a WorkflowReplaceOwnerOperation, which can be used to replace the owner of an active workflow based on the provided WorkflowReplaceOwnerRequest. Use WorkflowReplaceOwnerOperation.execute() to replace the owner of the workflow. For example:

 workflowInstanceService.replaceWorkflowOwner(workflowReplaceOwnerRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

Parameters:

request - the WorkflowReplaceOwnerRequest containing the information needed to replace the owner of the workflow. Requires an active workflow and the id of the new workflow owner.

Returns:

a WorkflowReplaceOwnerOperation, which can be used to replace the owner of the workflow.

newWorkflowUpdateDueDateRequestBuilder

WorkflowUpdateDueDateRequest.Builder newWorkflowUpdateDueDateRequestBuilder()

Creates a WorkflowUpdateDueDateRequest.Builder.

Returns:

a WorkflowUpdateDueDateRequest.Builder

updateWorkflowDueDate

WorkflowUpdateDueDateOperation updateWorkflowDueDate(WorkflowUpdateDueDateRequest request)

Creates a WorkflowUpdateDueDateOperation, which can be used to update the due date of an active workflow based on the provided WorkflowUpdateDueDateRequest. Use WorkflowUpdateDueDateOperation.execute() to update the workflow due date and dependent tasks due dates that are based on the workflow due date. For example:

 workflowInstanceService.updateWorkflowDueDate(workflowUpdateDueDateRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

Parameters:

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

Returns:

a WorkflowUpdateDueDateOperation, which can be used to update the workflow due date.

getWorkflowParticipantGroups

WorkflowParticipantGroupResponse getWorkflowParticipantGroups(String workflowId)

Retrieves a WorkflowParticipantGroupResponse containing workflow participant groups in the given active workflow.

Parameters:

workflowId - the ID of the active workflow to retrieve workflow participant groups

Returns:

a WorkflowParticipantGroupResponse containing the current workflow participant groups

getWorkflowItems

WorkflowItemsResponse getWorkflowItems(String workflowId)

Retrieves a WorkflowItemsResponse containing the items in the active workflow this action is executing against. Returned values reflect the items in the current transaction right before the call to the action method.

Parameters:

workflowId - the ID of the active workflow to retrieve workflow items

Returns:

a WorkflowItemsResponse containing the list of workflow items