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

Interface WorkflowRemoveItemsRequest.Builder

Enclosing interface:

WorkflowRemoveItemsRequest

public static interface WorkflowRemoveItemsRequest.Builder

Builds a WorkflowRemoveItemsRequest.

Method Summary

Modifier and Type	Method	Description
WorkflowRemoveItemsRequest	build()	Validates and retrieves a completed WorkflowRemoveItemsRequest.
WorkflowRemoveItemsRequest.Builder	withDocumentIds(List<String> documentIds)	Optional: sets the list of document IDs to remove from the active workflow.
WorkflowRemoveItemsRequest.Builder	withRecords(String objectName, List<String> recordIds)	Optional: sets the list of record IDs to remove from the active workflow.
WorkflowRemoveItemsRequest.Builder	withWorkflowId(String workflowId)	Required: sets the active workflow ID.

Method Details

withWorkflowId

WorkflowRemoveItemsRequest.Builder withWorkflowId(String workflowId)

Required: sets the active workflow ID.

Parameters:

workflowId - to apply the remove items action

Returns:

this WorkflowRemoveItemsRequest.Builder

withDocumentIds

WorkflowRemoveItemsRequest.Builder withDocumentIds(List<String> documentIds)

Optional: sets the list of document IDs to remove from the active workflow.

Parameters:

documentIds - list of document IDs being removed from the active workflow

Returns:

this WorkflowRemoveItemsRequest.Builder

withRecords

WorkflowRemoveItemsRequest.Builder withRecords(String objectName,
 List<String> recordIds)

Optional: sets the list of record IDs to remove from the active workflow.

Parameters:

objectName - object name of the records being removed from the active workflow.

recordIds - list of record IDs being removed from the active workflow

Returns:

this WorkflowRemoveItemsRequest.Builder

build

WorkflowRemoveItemsRequest build()

Validates and retrieves a completed WorkflowRemoveItemsRequest. Workflow ID is set and only one list of document or records IDs are set.

Returns:

this completed WorkflowRemoveItemsRequest