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

Interface Annotation.Builder

Enclosing interface:
Annotation
public static interface Annotation.Builder
Creates an instance of Annotation.

  • Method Details

    • appendReplies

      Annotation.Builder appendReplies(List<Annotation> replies)
      Optional: Specifies replies to append to this annotation. Not all annotation types allow replies.
      Parameters:
      replies - the non-null list of replies to add to this annotation
      Returns:
      this Annotation.Builder

    • withPlacemark

      Annotation.Builder withPlacemark(AnnotationPlacemark placemark)
      Conditional: Sets the AnnotationPlacemark. Required if the annotation is not a reply. If the annotation is a reply, you cannot specify a placemark, but Vault will assign one when placing the reply on its parent.
      Parameters:
      placemark - the non-null annotation placemark
      Returns:
      this Annotation.Builder

    • withReferences

      Annotation.Builder withReferences(List<AnnotationReference> references)
      Optional: Sets the references associated with this annotation. Requirements for references vary depending on annotation type.
      Parameters:
      references - the references associated with this annotation
      Returns:
      this Annotation.Builder

    • withTypeName

      Annotation.Builder withTypeName(String typeName)
      Conditional: Sets the name of the annotation type of this annotation. Required when creating annotations, not allowed when updating annotations.
      Parameters:
      typeName - the name of the annotation type of this annotation. Cannot be null or empty
      Returns:
      this Annotation.Builder

    • withValue

      Annotation.Builder withValue(String fieldName, Object value)
      Conditional: Specifies the value of a field with the given API name. The value class must match the Java class that backs the AnnotationValueType of the field. Setting a value for document_version_id__sys is required when creating an annotation.
      Parameters:
      fieldName - the name of the field to set value on
      value - the new value to set for the field. To remove an existing value, set to null.
      Returns:
      this Annotation.Builder

    • build

      Annotation build()
      Retrieves a completed Annotation.
      Returns:
      the completed Annotation