org.nuxeo.ecm.platform.comment.api
Interface CommentableDocument

All Superinterfaces:

Serializable

All Known Implementing Classes:

CommentableDocumentAdapter

public interface CommentableDocument
extends Serializable

Author:

George Lefter

Method Summary

DocumentModel	addComment(DocumentModel comment) Creates a new comment.
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()
                                throws ClientException

Returns all comments for this document.

Returns:

the list of comments

Throws:

ClientException

getComments

List<DocumentModel> getComments(DocumentModel parent)
                                throws ClientException

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

Throws:

ClientException

removeComment

void removeComment(DocumentModel comment)
                   throws ClientException

Removes a comment from the document comment list.

Parameters:

comment -

Throws:

ClientException

addComment

DocumentModel addComment(DocumentModel comment)
                         throws ClientException

Creates a new comment.

Parameters:

comment -

Throws:

ClientException

addComment

DocumentModel addComment(DocumentModel parent,
                         DocumentModel comment)
                         throws ClientException

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

Throws:

ClientException