Interface Comment
-
- All Known Subinterfaces:
Annotation
- All Known Implementing Classes:
AnnotationImpl
,CommentImpl
public interface Comment
Comment interface.- Since:
- 10.3
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addAncestorId(String ancestorId)
Deprecated.since 11.1, should be filled by document adapater factoryCollection<String>
getAncestorIds()
Gets the list of ancestor ids.String
getAuthor()
Gets comment author.Instant
getCreationDate()
Gets comment creation date.DocumentModel
getDocument()
Gets the document model backing this pojo.String
getId()
Gets comment id.Instant
getModificationDate()
Sets comment modification date.String
getParentId()
Gets parent id.String
getText()
Gets comment text.void
setAuthor(String author)
Sets comment author.void
setCreationDate(Instant creationDate)
Sets comment creation date.void
setId(String id)
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
setText(String text)
Sets comment text.
-
-
-
Method Detail
-
getId
String getId()
Gets comment id.- Returns:
- the id
-
setId
@Deprecated(since="11.1") void setId(String id)
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
void setParentId(String parentId)
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") void addAncestorId(String ancestorId)
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
void setAuthor(String author)
Sets comment author.- Parameters:
author
- the author
-
getText
String getText()
Gets comment text.- Returns:
- the text
-
setText
void setText(String text)
Sets comment text.- Parameters:
text
- the text
-
getCreationDate
Instant getCreationDate()
Gets comment creation date.- Returns:
- the creation date
-
setCreationDate
void setCreationDate(Instant creationDate)
Sets comment creation date.- Parameters:
creationDate
- the creation date
-
getModificationDate
Instant getModificationDate()
Sets comment modification date.- Returns:
- the modification date
-
setModificationDate
void setModificationDate(Instant modificationDate)
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
-
-