com.sss.controller

Class CommentsController

java.lang.Object

com.sss.controller.CommentsController

@RestController
public class CommentsController
extends java.lang.Object

Rest controller class. Accepts all supported requests that start with api/commentables and communicates with model layer using member variable that implements ICommentsService interface

Constructor Summary

Constructors

Constructor and Description
CommentsController()

Method Summary

Modifier and Type	Method and Description
CommentBO	add(CommentVO commentVO, java.lang.Long commentableId) This method adds a new comment to a specified by id commentable.
java.util.List<CommentBO>	comments(java.lang.Long commentableId) This method returns all comments that are available to a specified by id commentable.
void	delete(java.lang.Long commentableId, java.lang.Long commentId) This method deletes a specified by id comment to a specified by id commentable.
CommentBO	update(CommentVO commentVO, java.lang.Long commentableId, java.lang.Long commentId) This method updates an existing specified by id comment to a specified by id commentable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommentsController

public CommentsController()

Method Detail

add

@RequestMapping(method=POST,
                value="api/commentables/{commentableId}/comments")
public CommentBO add(@RequestBody
                                                                                                                     CommentVO commentVO,
                                                                                                                     @PathVariable
                                                                                                                     java.lang.Long commentableId)

This method adds a new comment to a specified by id commentable. It propagates request to model layer using ICommentsService method add.

Parameters:

commentVO - CommentVO's instance with user's input data

commentableId - Id of commentable to add a comment to

Returns:

CommentBO's instance for a new created record

comments

@RequestMapping(value="api/commentables/{commentableId}/comments")
public java.util.List<CommentBO> comments(@PathVariable
                                                                                                             java.lang.Long commentableId)

This method returns all comments that are available to a specified by id commentable. It propagates request to model layer using ICommentsService method findByCommentableId

Parameters:

commentableId - Id of commentable to receive comments to

Returns:

List of CommentBO's instances

update

@RequestMapping(method=PUT,
                value="api/commentables/{commentableId}/comments/{commentId}")
public CommentBO update(@RequestBody
                                                                                                                                   CommentVO commentVO,
                                                                                                                                   @PathVariable
                                                                                                                                   java.lang.Long commentableId,
                                                                                                                                   @PathVariable
                                                                                                                                   java.lang.Long commentId)

This method updates an existing specified by id comment to a specified by id commentable. It propagates request to model layer using ICommentsService method update.

Parameters:

commentVO - CommentVO's instance with user's changed and old data.

commentableId - Id of commentable to edit an comment to

commentId - Id of comment to edit

Returns:

CommentBO's instance for an edited record

delete

@RequestMapping(method=DELETE,
                value="api/commentables/{commentableId}/comments/{commentId}")
public void delete(@PathVariable
                                                                                                                                 java.lang.Long commentableId,
                                                                                                                                 @PathVariable
                                                                                                                                 java.lang.Long commentId)

This method deletes a specified by id comment to a specified by id commentable. It propagates request to model layer using ICommentsService method delete.

Parameters:

commentableId - Id of commentable to delete an comment to

commentId - Id of comment to delete