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

Interface DocumentLifecycleStateMetadataRequest.Builder

Enclosing interface:

DocumentLifecycleStateMetadataRequest

public static interface DocumentLifecycleStateMetadataRequest.Builder

Creates an instance of DocumentLifecycleStateMetadataRequest.

Method Summary

Modifier and Type	Method	Description
DocumentLifecycleStateMetadataRequest	build()	Validates and retrieves a completed DocumentLifecycleStateMetadataRequest.
DocumentLifecycleStateMetadataRequest.Builder	withActiveOnly()	Optional: Sets a filter to only retrieve active document lifecycle states.
DocumentLifecycleStateMetadataRequest.Builder	withLifecycleName(String lifecycleName)	Required: Sets the lifecycle name for the requested document lifecycle states.
DocumentLifecycleStateMetadataRequest.Builder	withStateNames(List<String> stateNames)	Optional: Sets the document lifecycle state names for the document lifecycle states requested.

Method Details

withLifecycleName

DocumentLifecycleStateMetadataRequest.Builder withLifecycleName(String lifecycleName)

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

Parameters:

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

Returns:

this DocumentLifecycleStateMetadataRequest.Builder

withStateNames

DocumentLifecycleStateMetadataRequest.Builder withStateNames(List<String> stateNames)

Optional: Sets the document lifecycle state names for the document lifecycle states requested.

Parameters:

stateNames - list of names of the document lifecycle states to retrieve metadata of. For example, draft_state__c. Cannot be empty.

Returns:

this DocumentLifecycleStateMetadataRequest.Builder

withActiveOnly

DocumentLifecycleStateMetadataRequest.Builder withActiveOnly()

Optional: Sets a filter to only retrieve active document lifecycle states.

Returns:

this DocumentLifecycleStateMetadataRequest.Builder

build

DocumentLifecycleStateMetadataRequest build()

Validates and retrieves a completed DocumentLifecycleStateMetadataRequest.

Returns:

this completed DocumentLifecycleStateMetadataRequest

Throws:

RuntimeException - if the document lifecycle name is not provided