CommentableDocument (Nuxeo 2021.53.3 API Documentation)

All Superinterfaces:

Serializable

All Known Implementing Classes:

CommentableDocumentAdapter
```
public interface CommentableDocument
extends Serializable
```
Author:

George Lefter

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`DocumentModel`	`addComment(DocumentModel comment)`	Creates a new comment.
`DocumentModel`	`addComment(DocumentModel comment, String path)`	Creates a new comment in a specific location.
`DocumentModel`	`addComment(DocumentModel parent, DocumentModel comment)`	Creates a new comment as a reply to an existing comment.
`List<DocumentModel>`	`getComments()`	Returns all comments for this document.
`List<DocumentModel>`	`getComments(DocumentModel parent)`	Returns the comments for this document that are replied to a parent comment.
`void`	`removeComment(DocumentModel comment)`	Removes a comment from the document comment list.

- Method Detail
  - getComments
```
List<DocumentModel> getComments()
```
    Returns all comments for this document.
    
    Returns:
    
    the list of comments
  - getComments
```
List<DocumentModel> getComments(DocumentModel parent)
```
    Returns the comments for this document that are replied to a parent comment.
    
    Parameters:
    
    parent - the parent comment
    
    Returns:
    
    the comments for the parent comment
  - removeComment
```
void removeComment(DocumentModel comment)
```
    Removes a comment from the document comment list.
  - addComment
```
DocumentModel addComment(DocumentModel comment)
```
    Creates a new comment.
  - addComment
```
DocumentModel addComment(DocumentModel comment,
                         String path)
```
    Creates a new comment in a specific location.
    
    Parameters:
    
    comment - the comment to be added
    
    path - the given location
    
    Since:
    
    10.2
  - addComment
```
DocumentModel addComment(DocumentModel parent,
                         DocumentModel comment)
```
    Creates a new comment as a reply to an existing comment.
    
    Parameters:
    
    parent - the parent comment, which must exist
    
    comment - the comment to be added