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

Interface DocumentLifecycleRoleMetadataRequest.Builder

Enclosing interface:

DocumentLifecycleRoleMetadataRequest

public static interface DocumentLifecycleRoleMetadataRequest.Builder

Creates an instance of DocumentLifecycleRoleMetadataRequest.

Method Summary

Modifier and Type	Method	Description
DocumentLifecycleRoleMetadataRequest	build()	Validates and retrieves a completed DocumentLifecycleRoleMetadataRequest.
DocumentLifecycleRoleMetadataRequest.Builder	withLifecycleName(String lifecycleName)	Required: Sets the lifecycle name for the requested document lifecycle roles.
DocumentLifecycleRoleMetadataRequest.Builder	withRoleNames(List<String> roleNames)	Optional: Sets the document lifecycle role names for the requested document lifecycle roles.

Method Details

withLifecycleName

DocumentLifecycleRoleMetadataRequest.Builder withLifecycleName(String lifecycleName)

Required: Sets the lifecycle name for the requested document lifecycle roles.

Parameters:

lifecycleName - given lifecycle name for the document lifecycle roles to retrieve metadata of. Cannot be null or empty. For example, submission_ready_lifecycle__v.

Returns:

this DocumentLifecycleRoleMetadataRequest.Builder

withRoleNames

DocumentLifecycleRoleMetadataRequest.Builder withRoleNames(List<String> roleNames)

Optional: Sets the document lifecycle role names for the requested document lifecycle roles.

Parameters:

roleNames - list of names of the document lifecycle roles to retrieve metadata of. For example, reviewer__c. Cannot be empty.

Returns:

this DocumentLifecycleRoleMetadataRequest.Builder

build

DocumentLifecycleRoleMetadataRequest build()

Validates and retrieves a completed DocumentLifecycleRoleMetadataRequest.

Returns:

this completed DocumentLifecycleRoleMetadataRequest

Throws:

RuntimeException - if the document lifecycle name is not specified