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

Interface DocumentLifecycleUserActionMetadataRequest.Builder

Enclosing interface:

DocumentLifecycleUserActionMetadataRequest

public static interface DocumentLifecycleUserActionMetadataRequest.Builder

Creates an instance of DocumentLifecycleUserActionMetadataRequest.

Method Summary

Modifier and Type	Method	Description
DocumentLifecycleUserActionMetadataRequest	build()	Retrieves a completed DocumentLifecycleUserActionMetadataRequest.
DocumentLifecycleUserActionMetadataRequest.Builder	withLifecycleName(String lifecycleName)	Required: Sets the lifecycle name of the document lifecycle associated with the requested document lifecycle user action.
DocumentLifecycleUserActionMetadataRequest.Builder	withStateName(String stateName)	Required: Sets the lifecycle state of the document lifecycle associated with the requested document lifecycle user action.

Method Details

withLifecycleName

DocumentLifecycleUserActionMetadataRequest.Builder withLifecycleName(String lifecycleName)

Required: Sets the lifecycle name of the document lifecycle associated with the requested document lifecycle user action.

Parameters:

lifecycleName - lifecycle name associated with the document lifecycle user action to retrieve metadata of. Cannot be null or empty. For example, submission_ready_lifecycle__v.

Returns:

this DocumentLifecycleUserActionMetadataRequest.Builder

withStateName

DocumentLifecycleUserActionMetadataRequest.Builder withStateName(String stateName)

Required: Sets the lifecycle state of the document lifecycle associated with the requested document lifecycle user action.

Parameters:

stateName - lifecycle state name associated with the document lifecycle user action to retrieve metadata of. Cannot be null or empty. For example, draft_state__c.

Returns:

this DocumentLifecycleUserActionMetadataRequest.Builder

build

DocumentLifecycleUserActionMetadataRequest build()

Retrieves a completed DocumentLifecycleUserActionMetadataRequest. Both lifecycle and state name must be provided.

Returns:

this completed DocumentLifecycleUserActionMetadataRequest

Throws:

RuntimeException - if any of the required values are not provided