org.nuxeo.ecm.rating

Class LikeServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.rating.LikeServiceImpl

All Implemented Interfaces:

LikeService, Adaptable, Component, Extensible, TimestampedService

public class LikeServiceImpl
extends DefaultComponent
implements LikeService

Default implementation of LikeService.

Since:

5.6

Author:

Thomas Roger

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISLIKE_RATING
static int	LIKE_RATING

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor and Description
LikeServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	cancel(String username, DocumentModel doc) Convenient method to cancel a like or dislike on a DocumentModel.
void	cancel(String username, String activityObject) Cancel a like or dislike for the given username.
void	dislike(String username, DocumentModel doc) Convenient method to dislike a DocumentModel.
void	dislike(String username, String activityObject) Dislike the given activityObject by the username.
long	getDislikesCount(DocumentModel doc) Convenient method to returns the dislikes count for a DocumentModel.
long	getDislikesCount(String activityObject) Returns the dislikes count for the given activityObject.
long	getLikesCount(DocumentModel doc) Convenient method to returns the likes count for a DocumentModel.
long	getLikesCount(String activityObject) Returns the likes count for the given activityObject.
LikeStatus	getLikeStatus(DocumentModel doc) Convenient method to return the LikeStatus for a DocumentModel.
LikeStatus	getLikeStatus(String activityObject) Returns the LikeStatus for the activityObject.
LikeStatus	getLikeStatus(String username, DocumentModel doc) Convenient method to return the LikeStatus for the username and a DocumentModel.
LikeStatus	getLikeStatus(String username, String activityObject) Returns the LikeStatus for the username and activityObject.
ActivitiesList	getMostLikedActivities(CoreSession session, int limit, DocumentModel source) An actitivitesList containing a documentActivity or a minimessageActivity as target, the likes count as object, current user as actor and actor's likes in context.
ActivitiesList	getMostLikedActivities(CoreSession session, int limit, DocumentModel source, Date fromDt, Date toDt) An actitivitesList containing a documentActivity or a minimessageActivity as target, the likes count as object, current user as actor and actor's likes in context the result will be between two dates
boolean	hasUserDisliked(String username, DocumentModel doc) Returns true if the given username already disliked the doc, false otherwise.
boolean	hasUserDisliked(String username, String activityObject) Returns true if the given username already disliked the activityObject, false otherwise.
boolean	hasUserLiked(String username, DocumentModel doc) Returns true if the given username already liked the doc, false otherwise.
boolean	hasUserLiked(String username, String activityObject) Returns true if the given username already liked the activityObject, false otherwise.
void	like(String username, DocumentModel doc) Convenient method to like a DocumentModel.
void	like(String username, String activityObject) Like the given activityObject by the username.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, registerExtension, setLastModified, setModifiedNow, setName, start, stop, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted, getApplicationStartedOrder

Field Detail

LIKE_RATING

public static final int LIKE_RATING

See Also:

Constant Field Values

DISLIKE_RATING

public static final int DISLIKE_RATING

See Also:

Constant Field Values

Constructor Detail

LikeServiceImpl

public LikeServiceImpl()

Method Detail

like

public void like(String username,
                 String activityObject)

Description copied from interface: LikeService

Like the given activityObject by the username.

Specified by:

like in interface LikeService

like

public void like(String username,
                 DocumentModel doc)

Description copied from interface: LikeService

Convenient method to like a DocumentModel.

Specified by:

like in interface LikeService

See Also:

LikeService.like(String, String)

hasUserLiked

public boolean hasUserLiked(String username,
                            String activityObject)

Description copied from interface: LikeService

Returns true if the given username already liked the activityObject, false otherwise.

Specified by:

hasUserLiked in interface LikeService

hasUserLiked

public boolean hasUserLiked(String username,
                            DocumentModel doc)

Description copied from interface: LikeService

Returns true if the given username already liked the doc, false otherwise.

Specified by:

hasUserLiked in interface LikeService

getLikesCount

public long getLikesCount(String activityObject)

Description copied from interface: LikeService

Returns the likes count for the given activityObject.

Specified by:

getLikesCount in interface LikeService

getLikesCount

public long getLikesCount(DocumentModel doc)

Description copied from interface: LikeService

Convenient method to returns the likes count for a DocumentModel.

Specified by:

getLikesCount in interface LikeService

See Also:

LikeService.getLikesCount(String)

dislike

public void dislike(String username,
                    String activityObject)

Description copied from interface: LikeService

Dislike the given activityObject by the username.

Specified by:

dislike in interface LikeService

dislike

public void dislike(String username,
                    DocumentModel doc)

Description copied from interface: LikeService

Convenient method to dislike a DocumentModel.

Specified by:

dislike in interface LikeService

See Also:

LikeService.dislike(String, String)

hasUserDisliked

public boolean hasUserDisliked(String username,
                               String activityObject)

Description copied from interface: LikeService

Returns true if the given username already disliked the activityObject, false otherwise.

Specified by:

hasUserDisliked in interface LikeService

hasUserDisliked

public boolean hasUserDisliked(String username,
                               DocumentModel doc)

Description copied from interface: LikeService

Returns true if the given username already disliked the doc, false otherwise.

Specified by:

hasUserDisliked in interface LikeService

getDislikesCount

public long getDislikesCount(String activityObject)

Description copied from interface: LikeService

Returns the dislikes count for the given activityObject.

Specified by:

getDislikesCount in interface LikeService

getDislikesCount

public long getDislikesCount(DocumentModel doc)

Description copied from interface: LikeService

Convenient method to returns the dislikes count for a DocumentModel.

Specified by:

getDislikesCount in interface LikeService

See Also:

LikeService.getDislikesCount(String)

cancel

public void cancel(String username,
                   String activityObject)

Description copied from interface: LikeService

Cancel a like or dislike for the given username.

Specified by:

cancel in interface LikeService

Parameters:

username - the username

activityObject - the activity object on which to cancel the like or dislike.

cancel

public void cancel(String username,
                   DocumentModel doc)

Description copied from interface: LikeService

Convenient method to cancel a like or dislike on a DocumentModel.

Specified by:

cancel in interface LikeService

See Also:

LikeService.cancel(String, String)

getLikeStatus

public LikeStatus getLikeStatus(String activityObject)

Description copied from interface: LikeService

Returns the LikeStatus for the activityObject.

Specified by:

getLikeStatus in interface LikeService

getLikeStatus

public LikeStatus getLikeStatus(DocumentModel doc)

Description copied from interface: LikeService

Convenient method to return the LikeStatus for a DocumentModel.

Specified by:

getLikeStatus in interface LikeService

See Also:

LikeService.getLikeStatus(String)

getLikeStatus

public LikeStatus getLikeStatus(String username,
                                String activityObject)

Description copied from interface: LikeService

Returns the LikeStatus for the username and activityObject.

The returned LikeStatus will have the information about the like / dislike status of the username.

Specified by:

getLikeStatus in interface LikeService

getLikeStatus

public LikeStatus getLikeStatus(String username,
                                DocumentModel doc)

Description copied from interface: LikeService

Convenient method to return the LikeStatus for the username and a DocumentModel.

Specified by:

getLikeStatus in interface LikeService

See Also:

LikeService.getLikeStatus(String, String)

getMostLikedActivities

public ActivitiesList getMostLikedActivities(CoreSession session,
                                             int limit,
                                             DocumentModel source,
                                             Date fromDt,
                                             Date toDt)

Description copied from interface: LikeService

An actitivitesList containing a documentActivity or a minimessageActivity as target, the likes count as object, current user as actor and actor's likes in context the result will be between two dates

Specified by:

getMostLikedActivities in interface LikeService

limit - maximum documents returned

source - the parent document when child will be reached

getMostLikedActivities

public ActivitiesList getMostLikedActivities(CoreSession session,
                                             int limit,
                                             DocumentModel source)

Description copied from interface: LikeService

An actitivitesList containing a documentActivity or a minimessageActivity as target, the likes count as object, current user as actor and actor's likes in context.

Specified by:

getMostLikedActivities in interface LikeService

limit - maximum documents returned

source - the parent document when child will be reached