lumis.service.commentit

Class CommentItResource

java.lang.Object

lumis.service.commentit.CommentItResource

@StableMinor(version="12.5",
             sinceVersion="8.0")
 @Path(value="/lumis/service/commentit/rest")
public class CommentItResource
extends Object

REST API for CommentIt service.

Since:

8.0.0

Version:

$Revision: 24140 $ $Date: 2020-09-14 21:50:42 +0000 (Mon, 14 Sep 2020) $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommentItResource.CommentsItem JAXB object used to represent the CommentItResource.CommentsList of a single item (itemId on a specific CommentIt service instance).
static class	CommentItResource.CommentsItemList JAXB object used to return a list of CommentItResource.CommentsItem.
static class	CommentItResource.CommentsList JAXB object used to return a list of Comment objects.

Constructor Summary

Constructors

Constructor and Description
CommentItResource()

Method Summary

Modifier and Type	Method and Description
Response	addComment(Comment comment) Adds a Comment.
void	deleteComment(String commentId) Delete the Comment with the identifier
Comment	getComment(String id) Returns a Comment by its identifier.
CommentItResource.CommentsItemList	getCommentsItems(String serviceInstanceId, List<String> itemIds, Integer limit) Get the newest Comment objects of the specified items, organized in CommentItResource.CommentsItem structures, up to the specified amount.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentItResource

public CommentItResource()

Method Detail

addComment

@POST
 @Path(value="/comments")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public Response addComment(@NotNull
                                                                                                                                     Comment comment)
                                                                                                                              throws PortalException

Adds a Comment.

Parameters:

comment - the Comment to add.

Returns:

A Response with the path to the Comment and the added Comment.

Throws:

PortalException

Since:

8.0.0

getComment

@GET
 @Path(value="/comments/{id:[A-F0-9]{32}}")
 @Produces(value="application/json")
public Comment getComment(@NotNull @PathParam(value="id")
                                                                                                                String id)
                                                                                                         throws PortalException

Returns a Comment by its identifier.

Parameters:

id - The identifier of the Comment.

Returns:

the Comment or a Response.Status.NOT_FOUND response if not found.

Throws:

PortalException

Since:

8.0.0

getCommentsItems

@GET
 @Path(value="/comments-items/{serviceInstanceId:[A-F0-9]{32}}")
 @Produces(value="application/json")
public CommentItResource.CommentsItemList getCommentsItems(@NotNull @PathParam(value="serviceInstanceId")
                                                                                                                                                                      String serviceInstanceId,
                                                                                                                                                                      @NotNull @NotEmpty @QueryParam(value="itemIds")
                                                                                                                                                                      List<String> itemIds,
                                                                                                                                                                      @NotNull @QueryParam(value="limit")
                                                                                                                                                                      Integer limit)
                                                                                                                                                               throws PortalException

Get the newest Comment objects of the specified items, organized in CommentItResource.CommentsItem structures, up to the specified amount.

Parameters:

serviceInstanceId - The instance identifier for the CommentIt service being use.

itemIds - The identifier of the items to retrieve the Comment objects from

limit - The maximum number of Comment objects to get.

Returns:

A CommentItResource.CommentsItemList object with the CommentItResource.CommentsList with a list of Comment objects for each item.

Throws:

PortalException

Since:

8.0.0

deleteComment

@DELETE
 @Path(value="/comments/{commentId:[A-F0-9]{32}}")
public void deleteComment(@NotNull @PathParam(value="commentId")
                                                                                     String commentId)
                                                                              throws PortalException

Delete the Comment with the identifier

Parameters:

commentId - the identifier of the Comment to delete

Throws:

PortalException

Since:

8.0.0