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

Interface PicklistValue

public interface PicklistValue

Provides access to picklist values, allowing retrieval of labels, status, and name.

Method Summary

Modifier and Type	Method	Description
String	getLabel()	Retrieves a picklist value's label.
String	getName()	Retrieves a picklist value's name.
boolean	isActive()	Determines if a picklist value is active or inactive.

Method Details

isActive

boolean isActive()

Determines if a picklist value is active or inactive.

Picklist values become inactive when a Vault Administrator removes them from the picklist. You cannot use inactive picklist values when updating or inserting a record.

Returns:

true if active, false if inactive

getLabel

String getLabel()

Retrieves a picklist value's 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 the Picklist was retrieved with PicklistService.getPicklist(String), this label is in the Vault's base language. If no label exists in the Vault's base language, returns the label in English.

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

Returns:

the picklist value label. If no label exists, returns null.

getName

String getName()

Retrieves a picklist value's name.

Returns:

the picklist value name