Package com.veeva.vault.sdk.api.annotation

Interface AnnotationReferenceField

public interface AnnotationReferenceField
Provides methods to retrieve common metadata information of the specified annotation reference field. You can find a full list and descriptions of annotation reference fields in the Developer Portal.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Returns the name of the annotation reference field.
    <T> AnnotationReferenceValueType<T>
    getValueType()
    Returns the value type of the annotation reference field.
    boolean
    hasValueSet()
    Retrieves whether values for the given annotation reference field are restricted to specific values defined in a value set.
    boolean
    isSystemManaged()
    Returns whether the annotation reference field is system-managed.

  • Method Details

    • getName

      String getName()
      Returns the name of the annotation reference field.
      Returns:
      the name of the annotation reference field

    • getValueType

      <T> AnnotationReferenceValueType<T> getValueType()
      Returns the value type of the annotation reference field.
      Type Parameters:
      T - the Java class that backs the value type
      Returns:
      the value type of the annotation reference field

    • hasValueSet

      boolean hasValueSet()
      Retrieves whether values for the given annotation reference field are restricted to specific values defined in a value set. This may vary based on annotation reference type. If true, use AnnotationMetadataService.getReferenceValueSet(AnnotationReferenceValueSetRequest) to retrieve specific values.
      Returns:
      true if the annotation reference field has specific allowed values, otherwise false

    • isSystemManaged

      boolean isSystemManaged()
      Returns whether the annotation reference field is system-managed.
      Returns:
      true if the annotation reference field is system-managed, otherwise false