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 and 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.
PicklistRequest.Builder	newPicklistRequestBuilder() Retrieves a PicklistRequest.Builder object, which can be used to build a PicklistRequest.

Method Detail

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 in the user's language.

Parameters:

picklistRequest - the context which contains picklist info to retrieve

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