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

Interface DocumentLifecycleStateUserActionMetadataService

All Superinterfaces:

Service

public interface DocumentLifecycleStateUserActionMetadataService
extends Service

Provides methods to retrieve metadata about document lifecycle user action, document version lifecycle user action, and user action user input.

Method Summary

Modifier and Type	Method	Description
DocumentVersionLifecycleUserActionMetadataResponse	getDocumentVersionUserActions(DocumentVersionLifecycleUserActionMetadataRequest request)	Retrieves all lifecycle user actions available for the document version in its current state.
DocumentLifecycleUserActionMetadataResponse	getUserActions(DocumentLifecycleUserActionMetadataRequest request)	Retrieves all lifecycle user actions configured for a given lifecycle state.
DocumentLifecycleUserActionUserInputMetadata	getUserInput(DocumentLifecycleUserActionUserInputMetadataRequest request)	Retrieves an instance of ObjectLifecycleUserActionInputParameterMetadata, containing details about the user input object if the action is a DocumentAction annotated with a user_input_object.
DocumentVersionLifecycleUserActionMetadataRequest.Builder	newDocumentVersionUserActionRequestBuilder()	Creates a DocumentVersionLifecycleUserActionMetadataRequest.Builder.
DocumentLifecycleUserActionMetadataRequest.Builder	newUserActionRequestBuilder()	Creates a DocumentLifecycleUserActionMetadataRequest.Builder.
DocumentLifecycleUserActionUserInputMetadataRequest.Builder	newUserInputRequestBuilder()	Creates a DocumentLifecycleUserActionUserInputMetadataRequest.Builder.

Method Details

newUserActionRequestBuilder

DocumentLifecycleUserActionMetadataRequest.Builder newUserActionRequestBuilder()

Creates a DocumentLifecycleUserActionMetadataRequest.Builder.

Returns:

a DocumentLifecycleUserActionMetadataRequest.Builder

getUserActions

DocumentLifecycleUserActionMetadataResponse getUserActions(DocumentLifecycleUserActionMetadataRequest request)

Retrieves all lifecycle user actions configured for a given lifecycle state. Requests support single document lifecycle states only.

Parameters:

request - the DocumentLifecycleUserActionMetadataRequest. Lifecycle state and name must both be provided.

Returns:

the DocumentLifecycleUserActionMetadataResponse

newDocumentVersionUserActionRequestBuilder

DocumentVersionLifecycleUserActionMetadataRequest.Builder newDocumentVersionUserActionRequestBuilder()

Creates a DocumentVersionLifecycleUserActionMetadataRequest.Builder.

Returns:

a DocumentVersionLifecycleUserActionMetadataRequest.Builder

getDocumentVersionUserActions

DocumentVersionLifecycleUserActionMetadataResponse getDocumentVersionUserActions(DocumentVersionLifecycleUserActionMetadataRequest request)

Retrieves all lifecycle user actions available for the document version in its current state.

Requests support single document versions only. Visibility and permission metadata for the run as user will be returned.

Parameters:

request - the DocumentVersionLifecycleUserActionMetadataRequest. Document ID or Document Version ID must be provided. A document version with the provided ID must exist in the Vault.

Returns:

the DocumentVersionLifecycleUserActionMetadataResponse

newUserInputRequestBuilder

DocumentLifecycleUserActionUserInputMetadataRequest.Builder newUserInputRequestBuilder()

Creates a DocumentLifecycleUserActionUserInputMetadataRequest.Builder.

Returns:

a DocumentLifecycleUserActionUserInputMetadataRequest.Builder

getUserInput

DocumentLifecycleUserActionUserInputMetadata getUserInput(DocumentLifecycleUserActionUserInputMetadataRequest request)

Retrieves an instance of ObjectLifecycleUserActionInputParameterMetadata, containing details about the user input object if the action is a DocumentAction annotated with a user_input_object.

This service does not provide metadata about run workflow start step inputs. Use com.veeva.vault.sdk.api.workflow.WorkflowMetadataService#getWorkflowStartMetadata(WorkflowStartMetadataRequest) instead if that is required.

Parameters:

request - the DocumentLifecycleUserActionUserInputMetadataRequest. A user action with the provided user action name must exist in the Vault.

Returns:

the DocumentLifecycleUserActionUserInputMetadata