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

Interface WorkflowStartInstanceRequest.Builder

Enclosing interface:

WorkflowStartInstanceRequest

public static interface WorkflowStartInstanceRequest.Builder

Builds a WorkflowStartInstanceRequest.

Method Summary

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

Method Details

withWorkflowName

WorkflowStartInstanceRequest.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 WorkflowStartInstanceRequest.Builder

withDocuments

WorkflowStartInstanceRequest.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 WorkflowStartInstanceRequest.Builder

withRecords

WorkflowStartInstanceRequest.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 WorkflowStartInstanceRequest.Builder

withInputParameters

WorkflowStartInstanceRequest.Builder withInputParameters(String key,
 Object value)

Optional: sets the input parameter key and value to start for the specified workflow. This can be used to set multiple keys with different values. For example, {number_field__c, 123}

Parameters:

key - key for the parameter. Cannot be null.

value - value for the parameter

Returns:

this WorkflowStartInstanceRequest.Builder

build

WorkflowStartInstanceRequest build()

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

Returns:

this completed WorkflowStartInstanceRequest