Class AnnotationInputV1

java.lang.Object
com.seeq.model.AnnotationInputV1

public class AnnotationInputV1 extends Object
AnnotationInputV1
  • Constructor Details

    • AnnotationInputV1

      public AnnotationInputV1()
  • Method Details

    • backupName

      public AnnotationInputV1 backupName(String backupName)
    • getBackupName

      public String getBackupName()
      The name of a Document backup to restore, when updating an annotation.
      Returns:
      backupName
    • setBackupName

      public void setBackupName(String backupName)
    • createdById

      public AnnotationInputV1 createdById(String createdById)
    • getCreatedById

      public String getCreatedById()
      The ID of the User that created this annotation. If omitted when creating a new annotation, the authenticated user is used by default. Only administrators may set this value.
      Returns:
      createdById
    • setCreatedById

      public void setCreatedById(String createdById)
    • description

      public AnnotationInputV1 description(String description)
    • getDescription

      public String getDescription()
      Clarifying information or other plain language description of this item. An input of just whitespaces is equivalent to a null input.
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • discoverable

      public AnnotationInputV1 discoverable(Boolean discoverable)
    • getDiscoverable

      public Boolean getDiscoverable()
      Whether this annotation is discoverable.
      Returns:
      discoverable
    • setDiscoverable

      public void setDiscoverable(Boolean discoverable)
    • document

      public AnnotationInputV1 document(String document)
    • getDocument

      public String getDocument()
      This annotation's document.
      Returns:
      document
    • setDocument

      public void setDocument(String document)
    • interests

      public AnnotationInputV1 interests(List<AnnotationInterestInputV1> interests)
    • addInterestsItem

      public AnnotationInputV1 addInterestsItem(AnnotationInterestInputV1 interestsItem)
    • getInterests

      public List<AnnotationInterestInputV1> getInterests()
      A list of IDs representing the annotation's items of interest
      Returns:
      interests
    • setInterests

      public void setInterests(List<AnnotationInterestInputV1> interests)
    • name

      public AnnotationInputV1 name(String name)
    • getName

      public String getName()
      Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.
      Returns:
      name
    • setName

      public void setName(String name)
    • repliesTo

      public AnnotationInputV1 repliesTo(String repliesTo)
    • getRepliesTo

      public String getRepliesTo()
      The ID of the Annotation that this annotation replies to.
      Returns:
      repliesTo
    • setRepliesTo

      public void setRepliesTo(String repliesTo)
    • reportInput

      public AnnotationInputV1 reportInput(OptionalReportInputV1 reportInput)
    • getReportInput

      public OptionalReportInputV1 getReportInput()
      Get reportInput
      Returns:
      reportInput
    • setReportInput

      public void setReportInput(OptionalReportInputV1 reportInput)
    • type

      public AnnotationInputV1 type(String type)
    • getType

      public String getType()
      This annotation's type: Report or Journal. Defaults to Journal.
      Returns:
      type
    • setType

      public void setType(String type)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object