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

Interface DocumentLifecycleStateUserActionService

All Superinterfaces:

Service

public interface DocumentLifecycleStateUserActionService
extends Service

Provides methods to execute a document lifecycle user action.

Method Summary

Modifier and Type	Method	Description
DocumentLifecycleUserActionExecutionOperation	executeUserAction(DocumentLifecycleUserActionExecutionRequest request)	Creates an instance of DocumentLifecycleUserActionExecutionOperation, which can be used to execute the user action based on the DocumentLifecycleUserActionExecutionRequest.
DocumentLifecycleUserActionExecutionRequest.Builder	newExecutionRequestBuilder()	Creates a DocumentLifecycleUserActionExecutionRequest.Builder.
DocumentLifecycleStartWorkflowInputParameter.Builder	newStartWorkflowInputParameterBuilder()	Creates a DocumentLifecycleStartWorkflowInputParameter.Builder.

Method Details

newExecutionRequestBuilder

DocumentLifecycleUserActionExecutionRequest.Builder newExecutionRequestBuilder()

Creates a DocumentLifecycleUserActionExecutionRequest.Builder.

Returns:

a DocumentLifecycleUserActionExecutionRequest.Builder

executeUserAction

DocumentLifecycleUserActionExecutionOperation executeUserAction(DocumentLifecycleUserActionExecutionRequest request)

Creates an instance of DocumentLifecycleUserActionExecutionOperation, which can be used to execute the user action based on the DocumentLifecycleUserActionExecutionRequest. Once success-handling and error-handling are (optionally) specified, you can call DocumentLifecycleUserActionExecutionOperation.execute() to execute the user action. For example:

 userActionService.executeUserAction(userActionExecutionRequest)
     .onSuccess(response -> { ... })
     .onFailure(response -> { ... })
     .execute()
 

A user action can only be submitted for a single document version. Only user actions that the requesting user has permission to execute will be executed.

Parameters:

request - the DocumentLifecycleUserActionExecutionRequest. A document version with the provided document ID/document version ID must exist in the Vault. A user action with the given name must exist.

Returns:

an instance of DocumentLifecycleUserActionExecutionOperation, which can be used to execute the user action.

newStartWorkflowInputParameterBuilder

DocumentLifecycleStartWorkflowInputParameter.Builder newStartWorkflowInputParameterBuilder()

Creates a DocumentLifecycleStartWorkflowInputParameter.Builder.

Returns:

a DocumentLifecycleStartWorkflowInputParameter.Builder