Package com.veeva.vault.sdk.api.lifecycle

Interface DocumentLifecycleUserActionExecutionRequest.Builder

Enclosing interface:

DocumentLifecycleUserActionExecutionRequest

public static interface DocumentLifecycleUserActionExecutionRequest.Builder

Creates an instance of DocumentLifecycleUserActionExecutionRequest.

Method Summary

Modifier and Type	Method	Description
DocumentLifecycleUserActionExecutionRequest	build()	Validates and retrieves a completed DocumentLifecycleUserActionExecutionRequest.
DocumentLifecycleUserActionExecutionRequest.Builder	withDocumentId(String documentId)	Optional: Sets the document ID value of the document to execute the action on.
DocumentLifecycleUserActionExecutionRequest.Builder	withDocumentVersionId(String documentVersionId)	Optional: Sets the document version ID value of the specific document version to execute the action on.
DocumentLifecycleUserActionExecutionRequest.Builder	withStartWorkflowInputParameters(List<DocumentLifecycleStartWorkflowInputParameter> startWorkflowInputParameters)	Optional: For a Run Workflow user action, sets the list of input parameters to start the workflow.
DocumentLifecycleUserActionExecutionRequest.Builder	withUserActionName(String userActionName)	Required: Sets the name value of the user action.
DocumentLifecycleUserActionExecutionRequest.Builder	withUserInputRecordId(String userInputRecordId)	Optional: For a DocumentAction configured as a user action, sets the record ID for the user_input_object.

Method Details

withDocumentId

DocumentLifecycleUserActionExecutionRequest.Builder withDocumentId(String documentId)

Optional: Sets the document ID value of the document to execute the action on.

Parameters:

documentId - the document's document ID value. Cannot be null or empty. For example, 951.

Returns:

this DocumentLifecycleUserActionExecutionRequest.Builder

withDocumentVersionId

DocumentLifecycleUserActionExecutionRequest.Builder withDocumentVersionId(String documentVersionId)

Optional: Sets the document version ID value of the specific document version to execute the action on.

Parameters:

documentVersionId - the specific document version's document version ID value. Cannot be null or empty. For example, 951_0_1.

Returns:

this DocumentLifecycleUserActionExecutionRequest.Builder

withUserActionName

DocumentLifecycleUserActionExecutionRequest.Builder withUserActionName(String userActionName)

Required: Sets the name value of the user action.

Parameters:

userActionName - the name of the user action

Returns:

this DocumentLifecycleUserActionExecutionRequest.Builder

withUserInputRecordId

DocumentLifecycleUserActionExecutionRequest.Builder withUserInputRecordId(String userInputRecordId)

Optional: For a DocumentAction configured as a user action, sets the record ID for the user_input_object.

Parameters:

userInputRecordId - record ID for the user_input_object

Returns:

this DocumentLifecycleUserActionExecutionRequest.Builder

withStartWorkflowInputParameters

DocumentLifecycleUserActionExecutionRequest.Builder withStartWorkflowInputParameters(List<DocumentLifecycleStartWorkflowInputParameter> startWorkflowInputParameters)

Optional: For a Run Workflow user action, sets the list of input parameters to start the workflow.

Parameters:

startWorkflowInputParameters - List of parameters used to start the workflow

Returns:

this DocumentLifecycleUserActionExecutionRequest.Builder

build

DocumentLifecycleUserActionExecutionRequest build()

Validates and retrieves a completed DocumentLifecycleUserActionExecutionRequest. All required values must be provided.

Returns:

the DocumentLifecycleUserActionExecutionRequest

Throws:

RuntimeException - if any of the required values are not provided, or if neither the document ID nor the document version ID is exclusively provided