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

Interface Picklist

public interface Picklist
Provides information about a picklist.

  • 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 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 label. If no label exists, returns null.

    • getPicklistValue

      PicklistValue getPicklistValue(String picklistValueName)
      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

      List<PicklistValue> getAllPicklistValues()
      Retrieves all PicklistValue objects for this picklist.
      Returns:
      a list of PicklistValue objects

    • getName

      String getName()
      Retrieves this Picklist's name.
      Returns:
      the picklist's name