lumis.service.likeit

Class LikeItResource

java.lang.Object

lumis.service.likeit.LikeItResource

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

REST API for LikeIt 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	LikeItResource.LikesItem JAXB object used to represent the Likes of a single item (itemId on a specific LikeIt service instance).
static class	LikeItResource.LikesItemList JAXB object used to return a list of LikeItResource.LikesItem.
static class	LikeItResource.LikesList JAXB object used to return a list of Like.

Constructor Summary

Constructors

Constructor and Description
LikeItResource()

Method Summary

Modifier and Type	Method and Description
Response	addLike(Like like) Adds a Like.
void	deleteLike(String likeId) Delete the Like with the identifier
Like	getLike(String id) Returns a Like by its identifier.
LikeItResource.LikesItemList	getLikesItems(String serviceInstanceId, List<String> itemIds) Get all Likes of the specified items, organized in LikeItResource.LikesItem structures.

Methods inherited from class java.lang.Object

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

Constructor Detail

LikeItResource

public LikeItResource()

Method Detail

addLike

@POST
 @Path(value="/likes")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public Response addLike(@NotNull
                                                                                                                               Like like)
                                                                                                                        throws PortalException

Adds a Like.

Parameters:

like - the Like to add.

Returns:

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

Throws:

PortalException

Since:

8.0.0

getLike

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

Returns a Like by its identifier.

Parameters:

id - the identifier of the Like.

Returns:

the Like, or a Response.Status.NOT_FOUND response if not found.

Throws:

PortalException

Since:

8.0.0

getLikesItems

@GET
 @Path(value="/likes-items/{serviceInstanceId:[A-F0-9]{32}}")
 @Produces(value="application/json")
public LikeItResource.LikesItemList getLikesItems(@NotNull @PathParam(value="serviceInstanceId")
                                                                                                                                                          String serviceInstanceId,
                                                                                                                                                          @NotNull @NotEmpty @QueryParam(value="itemIds")
                                                                                                                                                          List<String> itemIds)
                                                                                                                                                   throws PortalException

Get all Likes of the specified items, organized in LikeItResource.LikesItem structures.

Parameters:

serviceInstanceId - the service instance identifier where the content is

itemIds - the identifier of the content to retrieve the likes from

Returns:

A LikeItResource.LikesItem object with the list of likes.

Throws:

PortalException

Since:

8.0.0

deleteLike

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

Delete the Like with the identifier

Parameters:

likeId - the identifier of the Like to be deleted

Throws:

PortalException

Since:

8.0.0