Package com.seeq.model
Class AnnotationInputV1
java.lang.Object
com.seeq.model.AnnotationInputV1
AnnotationInputV1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddInterestsItem
(AnnotationInterestInputV1 interestsItem) backupName
(String backupName) createdById
(String createdById) description
(String description) discoverable
(Boolean discoverable) boolean
The name of a Document backup to restore, when updating an annotation.The ID of the User that created this annotation.Clarifying information or other plain language description of this item.Whether this annotation is discoverable.This annotation's document.A list of IDs representing the annotation's items of interestgetName()
Human readable name.The ID of the Annotation that this annotation replies to.Get reportInputgetType()
This annotation's type: Report or Journal.int
hashCode()
interests
(List<AnnotationInterestInputV1> interests) reportInput
(OptionalReportInputV1 reportInput) void
setBackupName
(String backupName) void
setCreatedById
(String createdById) void
setDescription
(String description) void
setDiscoverable
(Boolean discoverable) void
setDocument
(String document) void
setInterests
(List<AnnotationInterestInputV1> interests) void
void
setRepliesTo
(String repliesTo) void
setReportInput
(OptionalReportInputV1 reportInput) void
toString()
-
Constructor Details
-
AnnotationInputV1
public AnnotationInputV1()
-
-
Method Details
-
backupName
-
getBackupName
The name of a Document backup to restore, when updating an annotation.- Returns:
- backupName
-
setBackupName
-
createdById
-
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
-
description
-
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
-
discoverable
-
getDiscoverable
Whether this annotation is discoverable.- Returns:
- discoverable
-
setDiscoverable
-
document
-
getDocument
This annotation's document.- Returns:
- document
-
setDocument
-
interests
-
addInterestsItem
-
getInterests
A list of IDs representing the annotation's items of interest- Returns:
- interests
-
setInterests
-
name
-
getName
Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.- Returns:
- name
-
setName
-
repliesTo
-
getRepliesTo
The ID of the Annotation that this annotation replies to.- Returns:
- repliesTo
-
setRepliesTo
-
reportInput
-
getReportInput
Get reportInput- Returns:
- reportInput
-
setReportInput
-
type
-
getType
This annotation's type: Report or Journal. Defaults to Journal.- Returns:
- type
-
setType
-
equals
-
hashCode
public int hashCode() -
toString
-