Interface Comment
- All Known Subinterfaces:
Annotation
- All Known Implementing Classes:
AnnotationImpl
,CommentImpl
public interface Comment
Comment interface.
- Since:
- 10.3
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAncestorId
(String ancestorId) Deprecated.since 11.1, should be filled by document adapater factoryGets the list of ancestor ids.Gets comment author.Gets comment creation date.Gets the document model backing this pojo.getId()
Gets comment id.Sets comment modification date.Gets parent id.getText()
Gets comment text.void
Sets comment author.void
setCreationDate
(Instant creationDate) Sets comment creation date.void
Deprecated.since 11.1, you should use document adapter factory insteadvoid
setModificationDate
(Instant modificationDate) Sets comment modification date.void
setParentId
(String parentId) Sets parent id.void
Sets comment text.
-
Method Details
-
getId
String getId()Gets comment id.- Returns:
- the id
-
setId
Deprecated.since 11.1, you should use document adapter factory insteadSets comment id.- Parameters:
id
- the id
-
getParentId
String getParentId()Gets parent id.- Returns:
- the parent id
-
setParentId
Sets parent id.- Parameters:
parentId
- the parent id
-
getAncestorIds
Collection<String> getAncestorIds()Gets the list of ancestor ids.- Returns:
- the list of ancestor ids
-
addAncestorId
Deprecated.since 11.1, should be filled by document adapater factoryAdds an ancestor id.- Parameters:
ancestorId
- the ancestor id
-
getAuthor
String getAuthor()Gets comment author.- Returns:
- the author
-
setAuthor
Sets comment author.- Parameters:
author
- the author
-
getText
String getText()Gets comment text.- Returns:
- the text
-
setText
Sets comment text.- Parameters:
text
- the text
-
getCreationDate
Instant getCreationDate()Gets comment creation date.- Returns:
- the creation date
-
setCreationDate
Sets comment creation date.- Parameters:
creationDate
- the creation date
-
getModificationDate
Instant getModificationDate()Sets comment modification date.- Returns:
- the modification date
-
setModificationDate
Sets comment modification date.- Parameters:
modificationDate
- the modification date
-
getDocument
DocumentModel getDocument()Gets the document model backing this pojo.- Returns:
- the document model backing this pojo
- API Note:
- the returned document is detached
-