@ConsumerType public interface Comment
A Comment
represents an annotation created by a user (author) on a specific target (e.g. a page,
asset or any node for that matter). The comments are contained within a CommentCollection
(see getCollection()
. The comment collection is specific to a target (see CommentCollection.getTarget()
.
In its simplest form, a comment simply provides a comment text or "message" (see getMessage()
and access
to various meta data, such as creation date, who created it, etc.
Comments support attachments, i.e. files that are stored as part of a comment, e.g. a preview image if the comment is used to annotate an image.
Modifier and Type | Method and Description |
---|---|
Resource |
addAttachment(java.lang.String name,
java.io.InputStream inputStream,
java.lang.String mimeType)
Attach a file to this comment.
|
java.lang.String |
getAnnotationData()
Returns the string representing annotation data that is part of this comment and pertains to the target of the
associated comment collection.
|
Resource |
getAttachment(java.lang.String name)
Retrieve an attachment of this comment by its file name.
|
java.util.Map<java.lang.String,Resource> |
getAttachmentMap()
Retrieves a map, an entry of which represents a file-name/attachment pair.
|
java.lang.String |
getAuthorName()
Returns the author's identifying name that represents the author of this comment.
|
CommentCollection |
getCollection()
Returns the parent
CommentCollection this comment is a part of. |
java.util.Calendar |
getCreated()
The time stamp this comment was created.
|
java.util.Calendar |
getLastModified()
Returns the moment in time this collection was last modified.
|
java.lang.String |
getMessage()
Retrieves the message of this comment.
|
java.lang.String |
getPath()
Get the path of the resource representing this comment.
|
ValueMap |
getProperties()
Returns a
ValueMap holding all properties of this comment. |
void |
remove()
Removes (deletes) this comment from its collection.
|
void |
removeAttachment(java.lang.String name)
Removes an attachment from this comment, as identified by its name.
|
Resource addAttachment(java.lang.String name, java.io.InputStream inputStream, java.lang.String mimeType)
name
- The name of the file to attach.inputStream
- The InputStream
representing the contents of the file.mimeType
- The mime-type of this file.Resource
representing the attachment just added.CommentException
- Upon encountering an error during persistence of the attachment.java.lang.IllegalArgumentException
- if name or inputStream or mimeType is null or empty.java.lang.String getAnnotationData()
null
if none is present.Resource getAttachment(java.lang.String name)
name
- The file name of the attachment.Resource
representing the attachment, or null
if no attachment with the given name
exists.java.lang.String getAuthorName()
java.util.Map<java.lang.String,Resource> getAttachmentMap()
Map
representing the available attachments, or an empty map if no attachments are present.java.util.Calendar getCreated()
Calendar
representing creation time.java.util.Calendar getLastModified()
java.lang.String getMessage()
String
representing the message.CommentCollection getCollection()
CommentCollection
this comment is a part of.CommentCollection
.java.lang.String getPath()
ValueMap getProperties()
ValueMap
holding all properties of this comment.ValueMap
representing the properties.void removeAttachment(java.lang.String name)
name
- The name of the attachment to remove.CommentException
- If an error occurs removing the attachment.void remove()
CommentException
- Upon encountering an error while removing.Copyright © 2010 - 2020 Adobe. All Rights Reserved