Package org.opencastproject.event.comment

Interface EventCommentService

All Known Implementing Classes:

EventCommentServiceImpl

public interface EventCommentService

Method Summary

Modifier and Type	Method	Description
void	deleteComment(long commentId)	Delete a comment from an event.
void	deleteComments(String eventId)	Delete all comments from an event.
EventComment	getComment(long commentId)	Get a comment for a particular event.
List<EventComment>	getComments(String eventId)	Get all of the comments for an event.
List<String>	getReasons()	Get the available reasons for commenting on an event.
EventComment	updateComment(EventComment comment)	Update a comment.

Method Details

getReasons

List<String> getReasons()
                 throws EventCommentException

Get the available reasons for commenting on an event.

Returns:

A list of reasons of why a comment was made.

Throws:

EventCommentException - Thrown if there was an issue getting the comment reasons.

getComment

EventComment getComment(long commentId)
                 throws NotFoundException,
EventCommentException

Get a comment for a particular event.

Parameters:

commentId - The id for the comment.

Returns:

The comment

Throws:

NotFoundException - Thrown if the comment cannot be found.

EventCommentException - Thrown if there was an issue getting the comment.

getComments

List<EventComment> getComments(String eventId)
                        throws EventCommentException

Get all of the comments for an event.

Parameters:

eventId - The id of the event to get the comments for (mediapackage id).

Returns:

The List of comments.

Throws:

EventCommentException - Thrown if there was a problem getting the comments.

deleteComment

void deleteComment(long commentId)
            throws NotFoundException,
EventCommentException

Delete a comment from an event.

Parameters:

commentId - The id of the comment.

Throws:

NotFoundException - Thrown if cannot find the event / comment.

EventCommentException - Thrown if there is a problem deleting the comment.

deleteComments

void deleteComments(String eventId)
             throws NotFoundException,
EventCommentException

Delete all comments from an event.

Parameters:

eventId - The id of the event to get the comments for (mediapackage id).

Throws:

NotFoundException - Thrown if cannot find the event

EventCommentException - Thrown if there is a problem deleting the comments.

updateComment

EventComment updateComment(EventComment comment)
                    throws EventCommentException

Update a comment.

Parameters:

comment - The new comment status to update to.

Returns:

The comment updated.

Throws:

EventCommentException - Thrown if there is a problem updating the comment.