@ConsumerType public interface CommentCollection<C extends Comment>
CommentCollection
represents a collection of Comment
s. Comments can be added to and removed
from the collection. A collection is tied to a specific target (e.g. the page, asset or node that was commented on) -
see getTarget()
.Modifier and Type | Method and Description |
---|---|
C |
addComment(java.lang.String message,
java.lang.String author,
java.lang.String annotationData)
Create a new comment and add it to the collection.
|
java.util.List<C> |
getCommentList()
Returns all comments of this collection.
|
java.util.Calendar |
getCreated()
Returns the moment in time this collection was created.
|
java.util.Calendar |
getLastModified()
Returns the moment in time this collection was last modified.
|
java.lang.String |
getPath()
Returns the path of the resource representing this collection.
|
Resource |
getTarget()
Returns the
Resource representing the target this comment collection belongs to. |
void |
remove()
Removes (deletes) this comment collection.
|
C addComment(java.lang.String message, java.lang.String author, java.lang.String annotationData)
message
- The message of the comment.author
- The optional user ID to set as the author of the new comment. If none is provided, the
session user is considered the author.annotationData
- The optional annotation data. Annotation data may be used to store SVG data when commenting
on an image that is annotated with such data.CommentException
- Upon encountering an error during comment creation.java.util.List<C> getCommentList()
List
of comments of this collection, or an empty list if no comments are present.java.util.Calendar getCreated()
java.util.Calendar getLastModified()
java.lang.String getPath()
String
representing the path.Resource getTarget()
Resource
representing the target this comment collection belongs to.void remove()
CommentException
- Upon encountering an error while removing.Copyright © 2010 - 2020 Adobe. All Rights Reserved