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

Interface Annotation

public interface Annotation
Represents a document annotation. Provides methods to retrieve field values, references, placemarks, and type names for any annotation type.

  • Method Details

    • getPlacemark

      AnnotationPlacemark getPlacemark()
      Returns the placemark of the annotation, such as the text it appears on, the page it appears on, or the coordinates it appears on.
      Returns:
      the placemark of the annotation

    • getReferences

      List<AnnotationReference> getReferences()
      Returns the references associated with this annotation. Not all annotation types support references.
      Returns:
      the references associated with this annotation

    • getTypeName

      String getTypeName()
      Returns the name of the annotation type of this annotation.
      Returns:
      the name of the annotation type of this annotation

    • getValue

      <T> T getValue(String fieldName, AnnotationValueType<T> valueType)
      Returns the value of the field with the given name and type.
      Type Parameters:
      T - the Java class that backs the value type
      Parameters:
      fieldName - the name of the annotation field
      valueType - the value type of the field
      Returns:
      the value of the field