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

Interface ObjectLifecycleStateMetadataCollectionRequest.Builder

Enclosing interface:

ObjectLifecycleStateMetadataCollectionRequest

public static interface ObjectLifecycleStateMetadataCollectionRequest.Builder

Creates an instance of ObjectLifecycleStateMetadataCollectionRequest.

Method Summary

Modifier and Type	Method	Description
ObjectLifecycleStateMetadataCollectionRequest	build()	Validates and retrieves a completed ObjectLifecycleStateMetadataCollectionRequest.
ObjectLifecycleStateMetadataCollectionRequest.Builder	withActive(boolean active)	Optional: sets the status value for the object lifecycle states requested.
ObjectLifecycleStateMetadataCollectionRequest.Builder	withLifecycleName(String lifecycleName)	Required: sets the lifecycle name for the requested object lifecycle states.
ObjectLifecycleStateMetadataCollectionRequest.Builder	withStateTypeNames(List<String> stateTypeNames)	Optional: sets the names of the state types associated with the object lifecycle states requested.

Method Details

withLifecycleName

ObjectLifecycleStateMetadataCollectionRequest.Builder withLifecycleName(String lifecycleName)

Required: sets the lifecycle name for the requested object lifecycle states.

Parameters:

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

Returns:

this ObjectLifecycleStateMetadataCollectionRequest.Builder

withActive

ObjectLifecycleStateMetadataCollectionRequest.Builder withActive(boolean active)

Optional: sets the status value for the object lifecycle states requested. When omitted, retrieves all the states in the object lifecycle.

Parameters:

active - if true, retrieves all the object lifecycle states with the Active status; if false, retrieves all the object lifecycle states with the Inactive status

Returns:

this ObjectLifecycleStateMetadataCollectionRequest.Builder

withStateTypeNames

ObjectLifecycleStateMetadataCollectionRequest.Builder withStateTypeNames(List<String> stateTypeNames)

Optional: sets the names of the state types associated with the object lifecycle states requested.

Parameters:

stateTypeNames - the name of the state type associated with the object lifecycle states to retrieve metadata of. Cannot be null or empty. For example, initial_state__sys

Returns:

this ObjectLifecycleStateMetadataCollectionRequest.Builder

build

ObjectLifecycleStateMetadataCollectionRequest build()

Validates and retrieves a completed ObjectLifecycleStateMetadataCollectionRequest.

Returns:

this completed ObjectLifecycleStateMetadataCollectionRequest

Throws:

RuntimeException - if the object lifecycle name is not provided