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

Interface PicklistService

All Superinterfaces:

Service

public interface PicklistService
extends Service

Service to retrieve picklist information.

Method Summary

Modifier and Type	Method	Description
Picklist	getPicklist(PicklistRequest picklistRequest)	Given a picklist PicklistRequest, returns a Picklist object which can be used to retrieve picklist information.
Picklist	getPicklist(String pickListName)	Given a picklist Name, returns a Picklist object which can be used to retrieve picklist information.
PicklistDependencyMetadataCollectionResponse	getPicklistDependencyMetadataCollection(PicklistDependencyMetadataCollectionRequest request)	Retrieves a collection of picklist dependency metadata.
PicklistValueMetadataCollectionResponse	getPicklistValueMetadataCollection(PicklistValueMetadataCollectionRequest request)	Retrieves a collection of picklist value metadata.
PicklistDependencyMetadataCollectionRequest.Builder	newPicklistDependencyMetadataCollectionRequestBuilder()	Retrieves a PicklistDependencyMetadataCollectionRequest.Builder object, which can be used to build a PicklistDependencyMetadataCollectionRequest
PicklistRequest.Builder	newPicklistRequestBuilder()	Retrieves a PicklistRequest.Builder object, which can be used to build a PicklistRequest.
PicklistValueMetadataCollectionRequest.Builder	newPicklistValueMetadataCollectionRequestBuilder()	Retrieves a PicklistValueMetadataCollectionRequest.Builder object, which can be used to build a PicklistValueMetadataCollectionRequest

Method Details

getPicklist

Picklist getPicklist(String pickListName)

Given a picklist Name, returns a Picklist object which can be used to retrieve picklist information.

A Picklist created with this method contains the picklist label in the Vault's base language.

Parameters:

pickListName - the Name of a specific picklist to retrieve. For example, picklist__c.

Returns:

a Picklist object

getPicklist

Picklist getPicklist(PicklistRequest picklistRequest)

Given a picklist PicklistRequest, returns a Picklist object which can be used to retrieve picklist information.

A Picklist created with this method contains the picklist label dependent on the request. See Picklist.getLabel() for more details.

Parameters:

picklistRequest - the PicklistRequest containing context to retrieve a Picklist object.

Returns:

a Picklist object

newPicklistRequestBuilder

PicklistRequest.Builder newPicklistRequestBuilder()

Retrieves a PicklistRequest.Builder object, which can be used to build a PicklistRequest.

Returns:

a PicklistRequest.Builder object

getPicklistValueMetadataCollection

PicklistValueMetadataCollectionResponse getPicklistValueMetadataCollection(PicklistValueMetadataCollectionRequest request)

Retrieves a collection of picklist value metadata.

Parameters:

request - the PicklistValueMetadataCollectionRequest containing information about which picklist values to fetch

Returns:

the PicklistValueMetadataCollectionResponse containing the picklist value metadata

newPicklistValueMetadataCollectionRequestBuilder

PicklistValueMetadataCollectionRequest.Builder newPicklistValueMetadataCollectionRequestBuilder()

Retrieves a PicklistValueMetadataCollectionRequest.Builder object, which can be used to build a PicklistValueMetadataCollectionRequest

Returns:

the PicklistValueMetadataCollectionRequest.Builder object

getPicklistDependencyMetadataCollection

PicklistDependencyMetadataCollectionResponse getPicklistDependencyMetadataCollection(PicklistDependencyMetadataCollectionRequest request)

Retrieves a collection of picklist dependency metadata.

Parameters:

request - the PicklistDependencyMetadataCollectionRequest containing information about which picklist dependencies to fetch

Returns:

the PicklistDependencyMetadataCollectionResponse containing the picklist dependency metadata

newPicklistDependencyMetadataCollectionRequestBuilder

PicklistDependencyMetadataCollectionRequest.Builder newPicklistDependencyMetadataCollectionRequestBuilder()

Retrieves a PicklistDependencyMetadataCollectionRequest.Builder object, which can be used to build a PicklistDependencyMetadataCollectionRequest

Returns:

the PicklistDependencyMetadataCollectionRequest.Builder object