org.exoplatform.services.cms.comments

Interface CommentsService

public interface CommentsService

Manages comments related to the content.

Level API:

Experimental

Method Summary

Modifier and Type	Method and Description
void	addComment(javax.jcr.Node document, String commentor, String email, String site, String comment, String language) Adds comment to a document.
void	deleteComment(javax.jcr.Node commentNode) Deletes comment of a document by a given comment node.
List<javax.jcr.Node>	getComments(javax.jcr.Node document, String language) Gets all comments of a specified document node.
void	updateComment(javax.jcr.Node commentNode, String newComment) Updates comment for a document.

Method Detail

addComment

void addComment(javax.jcr.Node document,
                String commentor,
                String email,
                String site,
                String comment,
                String language)
         throws Exception

Adds comment to a document. This method uses variables to store values which are commented from the current user for all language types of this document.

Parameters:

document - The document node that is commented.

commentor - Name of the current user. If null, the commentor is considered as "anonymous".

email - Email of the current user. This param can be null.

site - Site of the current user. This param can be null.

comment - Content of the comment.

language - Language of the document that is commented.

Throws:

Exception

See Also:

Node

updateComment

void updateComment(javax.jcr.Node commentNode,
                   String newComment)
            throws Exception

Updates comment for a document.

Parameters:

commentNode - Node of the comment that will be updated.

newComment - The new comment that is set for the node.

Throws:

Exception

deleteComment

void deleteComment(javax.jcr.Node commentNode)
            throws Exception

Deletes comment of a document by a given comment node.

Parameters:

commentNode - The given comment node.

Throws:

Exception

getComments

List<javax.jcr.Node> getComments(javax.jcr.Node document,
                                 String language)
                          throws Exception

Gets all comments of a specified document node.

Parameters:

document - The document node that is commented.

language - Language of the document that is commented.

Throws:

Exception

See Also:

Node