Package com.veeva.vault.sdk.api.query

Interface QueryFacetResult

public interface QueryFacetResult
Represents the result for a single field in a QueryFacetResponse.

  • Method Details

    • getName

      String getName()
      Retrieves the name of the field.
      Returns:
      the name of the field

    • getLabel

      String getLabel()
      Retrieves the field label.
      Returns:
      the field label

    • getType

      QueryFacetResultType getType()
      Retrieves the QueryFacetResultType for this result.
      Returns:
      the type of this result

    • isTruncatedList

      boolean isTruncatedList()
      Checks whether the result has been truncated. Truncation occurs when there are more than 50 values in a result and only the first 50 values are returned.
      Returns:
      true if the result has been truncated, false otherwise

    • getCount

      int getCount()
      Retrieves the number of values in the result.
      Returns:
      the number of values in the result

    • getValues

      <T> List<QueryFacetValue<T>> getValues(ValueType<T> valueType)
      Retrieves a List of QueryFacetValues in this QueryFacetResult. The values are in descending order by count with a secondary ordering on the value.
      Type Parameters:
      T - the Java class that backs the value type
      Parameters:
      valueType - the ValueType of the values to return
      Returns:
      the List of values for this field result