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

Interface WorkflowInstanceCollectionRequest.Builder

Enclosing interface:

WorkflowInstanceCollectionRequest

public static interface WorkflowInstanceCollectionRequest.Builder

Builds an WorkflowInstanceCollectionRequest, used to retrieve WorkflowInstances.

Method Summary

Modifier and Type	Method	Description
WorkflowInstanceCollectionRequest	build()	Validates and constructs a completed WorkflowInstanceCollectionRequest.
WorkflowInstanceCollectionRequest.Builder	withDocuments(List<String> documents)	Optional: sets the list of documents against which workflows are being executed.
WorkflowInstanceCollectionRequest.Builder	withRecords(String objectName, List<String> recordIds)	Optional: sets the list of record IDs against which workflows are being executed.
WorkflowInstanceCollectionRequest.Builder	withWorkflowIds(List<String> workflowIds)	Optional: sets the workflow IDs to search for those workflows.

Method Details

withDocuments

WorkflowInstanceCollectionRequest.Builder withDocuments(List<String> documents)

Optional: sets the list of documents against which workflows are being executed. The listing can include either bound or unbound documents. For example, 100,101_0_1.

Parameters:

documents - list of documents to search against. Cannot be null or empty.

Returns:

this WorkflowInstanceCollectionRequest.Builder

withRecords

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

Optional: sets the list of record IDs against which workflows are being executed. This can be used to set multiple lists for different objects.

Parameters:

objectName - object name string to search against. Cannot be null or empty. For example, checklist__c.

recordIds - record ID string to search against. Cannot be null or empty. For example, V100,V200.

Returns:

this WorkflowInstanceCollectionRequest.Builder

withWorkflowIds

WorkflowInstanceCollectionRequest.Builder withWorkflowIds(List<String> workflowIds)

Optional: sets the workflow IDs to search for those workflows. If this is set, document or record IDs should not be set.

Parameters:

workflowIds - workflow IDs to search against. Cannot be null or empty. For example, 100,101.

Returns:

this WorkflowInstanceCollectionRequest.Builder

build

WorkflowInstanceCollectionRequest build()

Validates and constructs a completed WorkflowInstanceCollectionRequest. Either workflow IDs only or document or record IDs only are set.

Returns:

this completed WorkflowInstanceCollectionRequest