Package com.seeq.model
Class AnnotationOutputV1
java.lang.Object
com.seeq.model.AnnotationOutputV1
The list of items requested
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAssetSelectionIdsItem
(String assetSelectionIdsItem) addBackupsItem
(DocumentBackupOutputV1 backupsItem) addContentIdsItem
(String contentIdsItem) addCronScheduleItem
(String cronScheduleItem) addDateRangeIdsItem
(String dateRangeIdsItem) addInterestsItem
(AnnotationInterestOutputV1 interestsItem) addRepliesItem
(AnnotationOutputV1 repliesItem) assetSelectionIds
(List<String> assetSelectionIds) background
(Boolean background) backups
(List<DocumentBackupOutputV1> backups) contentIds
(List<String> contentIds) createdBy
(ItemPreviewV1 createdBy) cronSchedule
(List<String> cronSchedule) dateRangeIds
(List<String> dateRangeIds) description
(String description) discoverable
(Boolean discoverable) effectivePermissions
(PermissionsV1 effectivePermissions) boolean
fixedWidth
(Boolean fixedWidth) The IDs of Asset Selections included in this Report.Whether the Report, if scheduled, should continue to update if there are no subscribers (i.e.The list of backups for this Annotation's Document propertyWhether the Report/Journal is using CKEditorThe IDs of Content included in this Report.The ISO 8601 date of when the annotation was created (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)Get createdByReport update period.The IDs of Date Ranges included in this Report.Clarifying information or other plain language description of this itemFlag indicating whether this annotation is discoverableThis annotation's document.Get effectivePermissionsWhether the Report is enabled to run jobs.Whether the Report has a fixed width.getId()
The ID that can be used to interact with the itemThe list of the annotation's items of interestWhether item is archivedWhether item is redactedgetName()
The human readable nameThe next scheduled runtime for this Report, based on its Date Ranges.The ISO 8601 date of when the report was published (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)The list of Annotations that are replies to this oneID of the Annotation to which this is a replyThe ID of the Worksheet that the Report is associated toA plain language status message with information about any issues that may have been encountered during an operationThe IANA string name of the time zone of the report.The item's translation key, if anygetType()
The type of the itemThe ISO 8601 date of when the annotation was updated (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)int
hashCode()
interests
(List<AnnotationInterestOutputV1> interests) isArchived
(Boolean isArchived) isRedacted
(Boolean isRedacted) nextRunTime
(String nextRunTime) publishedAt
(String publishedAt) replies
(List<AnnotationOutputV1> replies) void
setAssetSelectionIds
(List<String> assetSelectionIds) void
setBackground
(Boolean background) void
setBackups
(List<DocumentBackupOutputV1> backups) void
setCkEnabled
(Boolean ckEnabled) void
setContentIds
(List<String> contentIds) void
setCreatedAt
(String createdAt) void
setCreatedBy
(ItemPreviewV1 createdBy) void
setCronSchedule
(List<String> cronSchedule) void
setDateRangeIds
(List<String> dateRangeIds) void
setDescription
(String description) void
setDiscoverable
(Boolean discoverable) void
setDocument
(String document) void
setEffectivePermissions
(PermissionsV1 effectivePermissions) void
setEnabled
(Boolean enabled) void
setFixedWidth
(Boolean fixedWidth) void
void
setInterests
(List<AnnotationInterestOutputV1> interests) void
setIsArchived
(Boolean isArchived) void
setIsRedacted
(Boolean isRedacted) void
void
setNextRunTime
(String nextRunTime) void
setPublishedAt
(String publishedAt) void
setReplies
(List<AnnotationOutputV1> replies) void
setRepliesTo
(String repliesTo) void
setReportsOn
(String reportsOn) void
setStatusMessage
(String statusMessage) void
setTimezone
(String timezone) void
setTranslationKey
(String translationKey) void
void
setUpdatedAt
(String updatedAt) statusMessage
(String statusMessage) toString()
translationKey
(String translationKey)
-
Constructor Details
-
AnnotationOutputV1
public AnnotationOutputV1()
-
-
Method Details
-
assetSelectionIds
-
addAssetSelectionIdsItem
-
getAssetSelectionIds
The IDs of Asset Selections included in this Report. Ignored for Journals- Returns:
- assetSelectionIds
-
setAssetSelectionIds
-
background
-
getBackground
Whether the Report, if scheduled, should continue to update if there are no subscribers (i.e. in the background). Ignored for Journals- Returns:
- background
-
setBackground
-
backups
-
addBackupsItem
-
getBackups
The list of backups for this Annotation's Document property- Returns:
- backups
-
setBackups
-
ckEnabled
-
getCkEnabled
Whether the Report/Journal is using CKEditor- Returns:
- ckEnabled
-
setCkEnabled
-
contentIds
-
addContentIdsItem
-
getContentIds
The IDs of Content included in this Report. Ignored for Journals- Returns:
- contentIds
-
setContentIds
-
createdAt
-
getCreatedAt
The ISO 8601 date of when the annotation was created (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)- Returns:
- createdAt
-
setCreatedAt
-
createdBy
-
getCreatedBy
Get createdBy- Returns:
- createdBy
-
setCreatedBy
-
cronSchedule
-
addCronScheduleItem
-
getCronSchedule
Report update period. Ignored for Journals- Returns:
- cronSchedule
-
setCronSchedule
-
dateRangeIds
-
addDateRangeIdsItem
-
getDateRangeIds
The IDs of Date Ranges included in this Report. Ignored for Journals- Returns:
- dateRangeIds
-
setDateRangeIds
-
description
-
getDescription
Clarifying information or other plain language description of this item- Returns:
- description
-
setDescription
-
discoverable
-
getDiscoverable
Flag indicating whether this annotation is discoverable- Returns:
- discoverable
-
setDiscoverable
-
document
-
getDocument
This annotation's document.- Returns:
- document
-
setDocument
-
effectivePermissions
-
getEffectivePermissions
Get effectivePermissions- Returns:
- effectivePermissions
-
setEffectivePermissions
-
enabled
-
getEnabled
Whether the Report is enabled to run jobs. Ignored for Journals- Returns:
- enabled
-
setEnabled
-
fixedWidth
-
getFixedWidth
Whether the Report has a fixed width. Ignored for Journals- Returns:
- fixedWidth
-
setFixedWidth
-
id
-
getId
The ID that can be used to interact with the item- Returns:
- id
-
setId
-
interests
-
addInterestsItem
-
getInterests
The list of the annotation's items of interest- Returns:
- interests
-
setInterests
-
isArchived
-
getIsArchived
Whether item is archived- Returns:
- isArchived
-
setIsArchived
-
isRedacted
-
getIsRedacted
Whether item is redacted- Returns:
- isRedacted
-
setIsRedacted
-
name
-
getName
The human readable name- Returns:
- name
-
setName
-
nextRunTime
-
getNextRunTime
The next scheduled runtime for this Report, based on its Date Ranges. Ignored for Journals- Returns:
- nextRunTime
-
setNextRunTime
-
publishedAt
-
getPublishedAt
The ISO 8601 date of when the report was published (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)- Returns:
- publishedAt
-
setPublishedAt
-
replies
-
addRepliesItem
-
getReplies
The list of Annotations that are replies to this one- Returns:
- replies
-
setReplies
-
repliesTo
-
getRepliesTo
ID of the Annotation to which this is a reply- Returns:
- repliesTo
-
setRepliesTo
-
reportsOn
-
getReportsOn
The ID of the Worksheet that the Report is associated to- Returns:
- reportsOn
-
setReportsOn
-
statusMessage
-
getStatusMessage
A plain language status message with information about any issues that may have been encountered during an operation- Returns:
- statusMessage
-
setStatusMessage
-
timezone
-
getTimezone
The IANA string name of the time zone of the report. Ignored for Journals- Returns:
- timezone
-
setTimezone
-
translationKey
-
getTranslationKey
The item's translation key, if any- Returns:
- translationKey
-
setTranslationKey
-
type
-
getType
The type of the item- Returns:
- type
-
setType
-
updatedAt
-
getUpdatedAt
The ISO 8601 date of when the annotation was updated (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)- Returns:
- updatedAt
-
setUpdatedAt
-
equals
-
hashCode
public int hashCode() -
toString
-