com.atlassian.confluence.like

Interface LikeEntityDao

All Known Implementing Classes:

HibernateLikeEntityDao

@ParametersAreNonnullByDefault
public interface LikeEntityDao

Persists and retrieves likes. Should only be accessed via a LikeManager. This interface replaces the deprecated LikeDao

Method Summary

Modifier and Type	Method and Description
LikeEntity	addLike(ContentEntityObject contentEntity, com.atlassian.user.User user) Add a like on the content entity for the given user.
Map<com.atlassian.bonnie.Searchable,Integer>	countLikes(Collection<? extends com.atlassian.bonnie.Searchable> searchables)
int	countLikes(com.atlassian.bonnie.Searchable contentEntity)
List<LikeEntity>	getLikeEntities(Collection<? extends ContentEntityObject> contentEntities)
boolean	hasLike(ContentEntityObject contentEntity, com.atlassian.user.User user) Returns true if the given user likes this content entity.
void	removeAllLikesFor(String username) Removes all likes (for any user) from the specified content entity.
void	removeAllLikesOn(ContentEntityObject contentEntity) Removes all likes (for any user) from the specified content entity.
void	removeLike(ContentEntityObject contentEntity, com.atlassian.user.User user) Remove like from content entity for the given user.

Method Detail

addLike

@Nonnull
LikeEntity addLike(ContentEntityObject contentEntity,
                            com.atlassian.user.User user)

Add a like on the content entity for the given user.

Parameters:

contentEntity - the content entity to add a like to

user - User liking the content

Returns:

the created Like

removeLike

void removeLike(ContentEntityObject contentEntity,
                com.atlassian.user.User user)

Remove like from content entity for the given user.

Parameters:

contentEntity - content entity to remove like from

user - User removing their Like

removeAllLikesOn

void removeAllLikesOn(ContentEntityObject contentEntity)

Removes all likes (for any user) from the specified content entity.

Parameters:

contentEntity - content entity

removeAllLikesFor

void removeAllLikesFor(String username)

Removes all likes (for any user) from the specified content entity.

Parameters:

username - the name of the user to remove all likes for

hasLike

boolean hasLike(ContentEntityObject contentEntity,
                com.atlassian.user.User user)

Returns true if the given user likes this content entity.

Parameters:

contentEntity - the content entity

user - the User the Like is being checked for

Returns:

true if the user likes this content entity.

getLikeEntities

@Nonnull
List<LikeEntity> getLikeEntities(Collection<? extends ContentEntityObject> contentEntities)

countLikes

int countLikes(com.atlassian.bonnie.Searchable contentEntity)

countLikes

@Nonnull
Map<com.atlassian.bonnie.Searchable,Integer> countLikes(Collection<? extends com.atlassian.bonnie.Searchable> searchables)