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

Interface AvailableWorkflowMetadataCollectionRequest.Builder

Enclosing interface:

AvailableWorkflowMetadataCollectionRequest

public static interface AvailableWorkflowMetadataCollectionRequest.Builder

Builds an AvailableWorkflowMetadataCollectionRequest, used to WorkflowMetadataService.getAvailableWorkflows(AvailableWorkflowMetadataCollectionRequest).

Method Summary

Modifier and Type	Method	Description
AvailableWorkflowMetadataCollectionRequest	build()	Validates and constructs a completed AvailableWorkflowMetadataCollectionRequest.
AvailableWorkflowMetadataCollectionRequest.Builder	withDocuments(List<String> documents)	Optional: sets the list of documents to search for any available workflows.
AvailableWorkflowMetadataCollectionRequest.Builder	withRecords(String objectName, List<String> recordIds)	Optional: sets the list of record IDs to search for any available workflows.

Method Details

withDocuments

AvailableWorkflowMetadataCollectionRequest.Builder withDocuments(List<String> documents)

Optional: sets the list of documents to search for any available workflows. The listing can include either bound or unbound documents.

Parameters:

documents - list of documents to search against. Cannot be null or empty. For example, 100,101_0_1.

Returns:

this AvailableWorkflowMetadataCollectionRequest.Builder

withRecords

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

Optional: sets the list of record IDs to search for any available workflows. 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 AvailableWorkflowMetadataCollectionRequest.Builder

build

AvailableWorkflowMetadataCollectionRequest build()

Validates and constructs a completed AvailableWorkflowMetadataCollectionRequest. Either documents or records are added.

Returns:

this completed AvailableWorkflowMetadataCollectionRequest