org.outerj.daisy.repository.comment
Interface CommentManager

public interface CommentManager

Method Summary

Comment	addComment(String documentId, CommentVisibility visibility, String commentText) Adds a comment to the branch "main", language "default" of this document.
Comment	addComment(String documentId, long branchId, long languageId, CommentVisibility visibility, String commentText)
void	deleteComment(Comment comment)
void	deleteComment(String documentId, long commentId) Deletes a comment from the branch "main", language "default" of the document.
void	deleteComment(String documentId, long branchId, long languageId, long commentId) Deletes a comment.
Comments	getComments() Returns all comments created by the current user.
Comments	getComments(CommentVisibility visibility) Returns all comments with the specified visibility, created by the current user.
Comments	getComments(String documentId) Gets the comments from the branch "main", languge "default" of the document.
Comments	getComments(String documentId, long branchId, long langugeId) Returns the comments for a specific document variant.
Comments	getComments(VariantKey variantKey)

Method Detail

addComment

Comment addComment(String documentId,
                   long branchId,
                   long languageId,
                   CommentVisibility visibility,
                   String commentText)
                   throws RepositoryException

Throws:

RepositoryException

addComment

Comment addComment(String documentId,
                   CommentVisibility visibility,
                   String commentText)
                   throws RepositoryException

Adds a comment to the branch "main", language "default" of this document.

Throws:

RepositoryException

deleteComment

void deleteComment(String documentId,
                   long branchId,
                   long languageId,
                   long commentId)
                   throws RepositoryException

Deletes a comment. These are the rules for deleting comments:

• Administrators can delete all comments, also private comments from other users.
• Users with write access to the document can delete their own private comments, public comments and editors-only comments.
• Other users can only delete their own private comments.

Throws:

RepositoryException

deleteComment

void deleteComment(String documentId,
                   long commentId)
                   throws RepositoryException

Deletes a comment from the branch "main", language "default" of the document.

Throws:

RepositoryException

deleteComment

void deleteComment(Comment comment)
                   throws RepositoryException

Throws:

RepositoryException

getComments

Comments getComments(String documentId,
                     long branchId,
                     long langugeId)
                     throws RepositoryException

Returns the comments for a specific document variant. Only private comment of the current user will be included (also for administrators). Editors-only comments are only included when the user has write access to the document.

The comments are ordered by creation date.

Throws:

RepositoryException

getComments

Comments getComments(VariantKey variantKey)
                     throws RepositoryException

Throws:

RepositoryException

See Also:

getComments(String, long, long)

getComments

Comments getComments(String documentId)
                     throws RepositoryException

Gets the comments from the branch "main", languge "default" of the document.

Throws:

RepositoryException

getComments

Comments getComments(CommentVisibility visibility)
                     throws RepositoryException

Returns all comments with the specified visibility, created by the current user.

Throws:

RepositoryException

getComments

Comments getComments()
                     throws RepositoryException

Returns all comments created by the current user.

Throws:

RepositoryException