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

Interface DocumentLifecycleMetadataRequest.Builder

Enclosing interface:

DocumentLifecycleMetadataRequest

public static interface DocumentLifecycleMetadataRequest.Builder

Creates an instance of DocumentLifecycleMetadataRequest.

Method Summary

Modifier and Type	Method	Description
DocumentLifecycleMetadataRequest	build()	Validates and retrieves a completed DocumentLifecycleMetadataRequest.
DocumentLifecycleMetadataRequest.Builder	withActiveOnly()	Optional: Sets a filter to only retrieve active document lifecycles.
DocumentLifecycleMetadataRequest.Builder	withLifecycleNames(List<String> lifecycleNames)	Optional: Sets the document lifecycle names to retrieve metadata of.

Method Details

withLifecycleNames

DocumentLifecycleMetadataRequest.Builder withLifecycleNames(List<String> lifecycleNames)

Optional: Sets the document lifecycle names to retrieve metadata of. When omitted, retrieves all document lifecycles in the Vault.

Parameters:

lifecycleNames - the names of the document lifecycles to retrieve metadata of. For example, submission_ready_lifecycle__v. Cannot be empty.

Returns:

this DocumentLifecycleMetadataRequest.Builder

withActiveOnly

DocumentLifecycleMetadataRequest.Builder withActiveOnly()

Optional: Sets a filter to only retrieve active document lifecycles.

Returns:

this DocumentLifecycleMetadataRequest.Builder

build

DocumentLifecycleMetadataRequest build()

Validates and retrieves a completed DocumentLifecycleMetadataRequest.

Returns:

this completed DocumentLifecycleMetadataRequest