com.veeva.vault.sdk.api.workflow

Interface WorkflowStartMetadataRequest.Builder

Enclosing interface:

WorkflowStartMetadataRequest

public static interface WorkflowStartMetadataRequest.Builder

Builds a WorkflowStartMetadataRequest.

Method Summary

Modifier and Type	Method and Description
WorkflowStartMetadataRequest	build() Validates and retrieves a completed WorkflowStartMetadataRequest.
WorkflowStartMetadataRequest.Builder	withDocuments(List<String> documents) Optional: sets the list of documents to search for the specified workflow.
WorkflowStartMetadataRequest.Builder	withRecords(String objectName, List<String> recordIds) Optional: sets the list of record IDs to search for the specified workflow.
WorkflowStartMetadataRequest.Builder	withWorkflowName(String workflowName) Required: adds the specified workflow name to search with.

Method Detail

withWorkflowName

WorkflowStartMetadataRequest.Builder withWorkflowName(String workflowName)

Required: adds the specified workflow name to search with.

Parameters:

workflowName - workflow name to search with. For example, review_workflow__c.

Returns:

this WorkflowStartMetadataRequest.Builder

withDocuments

WorkflowStartMetadataRequest.Builder withDocuments(List<String> documents)

Optional: sets the list of documents to search for the specified workflow. 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 WorkflowStartMetadataRequest.Builder

withRecords

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

Optional: sets the list of record IDs to search for the specified workflow. 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 WorkflowStartMetadataRequest.Builder

build

WorkflowStartMetadataRequest build()

Validates and retrieves a completed WorkflowStartMetadataRequest. Workflow name is set and either documents or records are added.

Returns:

this completed WorkflowStartMetadataRequest