Package com.veeva.vault.sdk.api.picklist

Interface PicklistValueMetadataCollectionRequest.Builder

Enclosing interface:

PicklistValueMetadataCollectionRequest

public static interface PicklistValueMetadataCollectionRequest.Builder

Creates an instance of PicklistValueMetadataCollectionRequest.

Method Summary

Modifier and Type	Method	Description
PicklistValueMetadataCollectionRequest	build()	Validates and retrieves a completed PicklistValueMetadataCollectionRequest.
PicklistValueMetadataCollectionRequest.Builder	withControllingPicklistValueNames(List<String> controllingPicklistValueNames)	Optional: Filters the list of picklist values to those that have a configured dependency on one of the provided controlling values.
PicklistValueMetadataCollectionRequest.Builder	withInactive()	Optional: When invoked, inactive values will be returned in addition to active values.
PicklistValueMetadataCollectionRequest.Builder	withLanguage(String language)	Optional: Returns the picklist value labels in the specified language.
PicklistValueMetadataCollectionRequest.Builder	withPicklistName(String picklistName)	Required: Indicates what picklist to retrieve values from.
PicklistValueMetadataCollectionRequest.Builder	withPicklistValueNames(List<String> picklistValueNames)	Optional: Filters the list of picklist values returned to those that match the provided picklist value names.

Method Details

withPicklistName

PicklistValueMetadataCollectionRequest.Builder withPicklistName(String picklistName)

Required: Indicates what picklist to retrieve values from.

Parameters:

picklistName - name of the picklist. Cannot be null or empty. Picklist must exist.

Returns:

this PicklistValueMetadataCollectionRequest.Builder

withInactive

PicklistValueMetadataCollectionRequest.Builder withInactive()

Optional: When invoked, inactive values will be returned in addition to active values. By default, only active values are returned.

Returns:

this PicklistValueMetadataCollectionRequest.Builder

withLanguage

PicklistValueMetadataCollectionRequest.Builder withLanguage(String language)

Optional: Returns the picklist value labels in the specified language. If a label doesn't exist in the specified language, or if a language is not specified, then the picklist value label is returned in the user's language. If no label exists in the user's language, then the label is returned in the Vault's base language. If no label exists in the base language, then the picklist value label is returned in English.

Parameters:

language - language for picklist value labels

Returns:

this PicklistValueMetadataCollectionRequest.Builder

withPicklistValueNames

PicklistValueMetadataCollectionRequest.Builder withPicklistValueNames(List<String> picklistValueNames)

Optional: Filters the list of picklist values returned to those that match the provided picklist value names.

Parameters:

picklistValueNames - name of picklist values to include in the returned values

Returns:

this PicklistValueMetadataCollectionRequest.Builder

withControllingPicklistValueNames

PicklistValueMetadataCollectionRequest.Builder withControllingPicklistValueNames(List<String> controllingPicklistValueNames)

Optional: Filters the list of picklist values to those that have a configured dependency on one of the provided controlling values.

Parameters:

controllingPicklistValueNames - names of picklist values from the controlling picklist

Returns:

this PicklistValueMetadataCollectionRequest.Builder

build

PicklistValueMetadataCollectionRequest build()

Validates and retrieves a completed PicklistValueMetadataCollectionRequest.

Returns:

the completed PicklistValueMetadataCollectionRequest