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

Interface ObjectLifecycleStateUserActionService

All Superinterfaces:

Service

public interface ObjectLifecycleStateUserActionService
extends Service

Provides methods to execute an object lifecycle user action.

Method Summary

Modifier and Type	Method	Description
UserActionExecutionOperation<UserActionExecutionResponse>	executeUserAction(UserActionExecutionRequest request)	Creates an instance of UserActionExecutionOperation, which can be used to execute the user action based on the UserActionExecutionRequest.
UserActionExecutionRequest.Builder	newExecutionRequestBuilder()	Creates a UserActionExecutionRequest.Builder.

Method Details

newExecutionRequestBuilder

UserActionExecutionRequest.Builder newExecutionRequestBuilder()

Creates a UserActionExecutionRequest.Builder.

Returns:

a UserActionExecutionRequest.Builder

executeUserAction

UserActionExecutionOperation<UserActionExecutionResponse> executeUserAction(UserActionExecutionRequest request)

Creates an instance of UserActionExecutionOperation, which can be used to execute the user action based on the UserActionExecutionRequest. Once success-handling and error-handling are (optionally) specified, you can call UserActionExecutionOperation.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 record. Only user actions that the requesting user has permission to execute will be executed.

Parameters:

request - the UserActionExecutionRequest. An object with the provided object name and the record with the provided record ID must exist in the Vault. A user action with the given name must exist.

Returns:

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