Interface DocumentLifecycleStateUserActionService
- All Superinterfaces:
Service
Provides methods to execute a document lifecycle user action.
-
Method Summary
Modifier and TypeMethodDescriptionCreates an instance ofDocumentLifecycleUserActionExecutionOperation
, which can be used to execute the user action based on theDocumentLifecycleUserActionExecutionRequest
.
-
Method Details
-
newExecutionRequestBuilder
DocumentLifecycleUserActionExecutionRequest.Builder newExecutionRequestBuilder() -
executeUserAction
DocumentLifecycleUserActionExecutionOperation executeUserAction(DocumentLifecycleUserActionExecutionRequest request) Creates an instance ofDocumentLifecycleUserActionExecutionOperation
, which can be used to execute the user action based on theDocumentLifecycleUserActionExecutionRequest
. Once success-handling and error-handling are (optionally) specified, you can callDocumentLifecycleUserActionExecutionOperation.execute()
to execute the user action. For example:userActionService.executeUserAction(userActionExecutionRequest) .onSuccess(response -> { ... }) .onFailure(response -> { ... }) .execute()
- Parameters:
request
- theDocumentLifecycleUserActionExecutionRequest
. 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()
-