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

Interface Picklist

public interface Picklist

Provides methods to retrieve information about a picklist.

Method Summary

Modifier and Type	Method	Description
List<PicklistValue>	getAllPicklistValues()	Deprecated. as of 24R3.4, replaced by PicklistService.getPicklistValueMetadataCollection(PicklistValueMetadataCollectionRequest) Retrieves all PicklistValue objects for this picklist.
String	getControllingPicklistName()	Returns the name (public key) of the controlling picklist.
String	getLabel()	Retrieves this Picklist's UI label.
String	getName()	Retrieves this Picklist's name.
PicklistValue	getPicklistValue(String picklistValueName)	Deprecated. as of 24R3.4, replaced by PicklistService.getPicklistValueMetadataCollection(PicklistValueMetadataCollectionRequest) Retrieves a PicklistValue object for a specific picklist value name.
boolean	hasControllingPicklist()	Indicates whether the picklist has a controlling picklist.
boolean	isSystemManaged()	Indicates whether the picklist is system-managed.

Method Details

getLabel

String getLabel()

Retrieves this Picklist's UI label. Depending on the method used to retrieve this Picklist, the label may be in the Vault's base language or the user's language. Learn more about base language and user language in Vault Help.

If this Picklist was retrieved with PicklistService.getPicklist(String), the label is in the Vault's base language. If no label exists in the Vault's base language, returns the label in English.

If this Picklist was retrieved with PicklistService.getPicklist(PicklistRequest), the label defaulting behavior is dependent on the request. For more details, see PicklistRequest

Returns:

the picklist label

getPicklistValue

@Deprecated
PicklistValue getPicklistValue(String picklistValueName)

Deprecated.

as of 24R3.4, replaced by PicklistService.getPicklistValueMetadataCollection(PicklistValueMetadataCollectionRequest) Retrieves a PicklistValue object for a specific picklist value name.

Parameters:

picklistValueName - the name of a picklist value

Returns:

a PicklistValue object for the picklist value name specified in the parameter

getAllPicklistValues

@Deprecated
List<PicklistValue> getAllPicklistValues()

Deprecated.

as of 24R3.4, replaced by PicklistService.getPicklistValueMetadataCollection(PicklistValueMetadataCollectionRequest) Retrieves all PicklistValue objects for this picklist. Returns the PicklistValue objects in ascending order, as designated by the picklist value's order attribute. Picklist values that share the same order value are returned in the order they were configured. Retrieve the order of the picklist values with the Retrieve Component Record (XML/JSON) endpoint on the Picklist component.

Returns:

a list of PicklistValue objects in ascending order, as designated by the picklist value's order attribute

getName

String getName()

Retrieves this Picklist's name.

Returns:

the picklist's name

isSystemManaged

boolean isSystemManaged()

Indicates whether the picklist is system-managed.

Returns:

true if the picklist is system-managed, otherwise false

hasControllingPicklist

boolean hasControllingPicklist()

Indicates whether the picklist has a controlling picklist.

Returns:

true if the picklist has a controlling picklist, otherwise false

getControllingPicklistName

String getControllingPicklistName()

Returns the name (public key) of the controlling picklist. Returns null if no controlling picklist exists.

Returns:

name of the controlling picklist