org.nuxeo.ecm.rating.api

Class LikeStatus

java.lang.Object

org.nuxeo.ecm.rating.api.LikeStatus

public class LikeStatus
extends Object

An object storing the like / dislike status of an activity object.

It may also contain the like status for a username:

• LIKED
• DISLIKED
• UNKNOWN

Since:

5.6

Author:

Thomas Roger

Field Summary

Fields

Modifier and Type	Field and Description
String	activityObject
static int	DISLIKED Constant used when the username disliked the activityObject.
long	dislikesCount
static int	LIKED Constant used when the username liked the activityObject .
long	likesCount
static int	UNKNOWN Constant used when the username didn't like nor dislike the activityObject.
int	userLikeStatus
String	username

Constructor Summary

Constructors

Constructor and Description
LikeStatus(String activityObject, long likesCount, long dislikesCount) Creates a LikeStatus without the like status for a username.
LikeStatus(String activityObject, long likesCount, long dislikesCount, String username, int userLikeStatus) Creates a LikeStatus with the like status for the specified username.

Method Summary

Modifier and Type	Method and Description
Map<String,Serializable>	toMap() Returns a Map of attributes for this LikeStatus.

Methods inherited from class java.lang.Object

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

Field Detail

LIKED

public static final int LIKED

Constant used when the username liked the activityObject .

See Also:

Constant Field Values

DISLIKED

public static final int DISLIKED

Constant used when the username disliked the activityObject.

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

Constant used when the username didn't like nor dislike the activityObject.

See Also:

Constant Field Values

activityObject

public final String activityObject

likesCount

public final long likesCount

dislikesCount

public final long dislikesCount

username

public final String username

userLikeStatus

public final int userLikeStatus

Constructor Detail

LikeStatus

public LikeStatus(String activityObject,
                  long likesCount,
                  long dislikesCount,
                  String username,
                  int userLikeStatus)

Creates a LikeStatus with the like status for the specified username.

Parameters:

activityObject - the activity object for which this LikeStatus apply

likesCount - the likes count for the activity object

dislikesCount - the dislikes count for the activity object

username - the username on which the userLikeStatus apply

userLikeStatus - the like status for the username

LikeStatus

public LikeStatus(String activityObject,
                  long likesCount,
                  long dislikesCount)

Creates a LikeStatus without the like status for a username.

Parameters:

activityObject - the activity object for which this LikeStatus apply

likesCount - the likes count for the activity object

dislikesCount - the dislikes count for the activity object

Method Detail

toMap

public Map<String,Serializable> toMap()

Returns a Map of attributes for this LikeStatus.