Interface PicklistValue


public interface PicklistValue
Provides access to picklist values, allowing retrieval of labels, status, name, and whether or not the value has dependencies.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the names (public keys) of the controlling picklist values.
    Retrieves a picklist value's label.
    Retrieves a picklist value's name.
    int
    Retrieves the display order of the picklist value.
    boolean
    Indicates whether the picklist value is dependent on controlling values.
    boolean
    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 the picklist value, the label will be translated as follows:
      Returns:
      the picklist value label.
    • getName

      String getName()
      Retrieves a picklist value's name.
      Returns:
      the picklist value name
    • getOrder

      int getOrder()
      Retrieves the display order of the picklist value.
      Returns:
      the picklist value order
    • hasControllingValues

      boolean hasControllingValues()
      Indicates whether the picklist value is dependent on controlling values.
      Returns:
      true if the picklist value has controlling values, otherwise false
    • getControllingValueNames

      List<String> getControllingValueNames()
      Returns the names (public keys) of the controlling picklist values. Returns an empty list if no controlling values exist.
      Returns:
      names of the controlling picklist values