com.communote.server.core.follow

Interface FollowManagement

All Known Implementing Classes:

FollowManagementBase, FollowManagementImpl

@Transactional(propagation=REQUIRED)
public interface FollowManagement

Service class providing follow functionality.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
void	followBlog(Long blogId) Adds the specified blog/topic to the followed items of the current user.
void	followDiscussion(Long discussionId) Adds the discussion with the specified ID to the followed items of the current user.
void	followDiscussionByNoteId(Long noteId) Adds the discussion of the specified note to the followed items of the current user.
boolean	followsBlog(Long blogId) Returns whether the current user follows the blog.
boolean	followsDiscussion(Long discussionId) Returns true if the current user follows the discussion, otherwise false.
boolean	followsTag(Long id) Returns true if the current user follows the tag, otherwise false.
boolean	followsUser(Long userId) Returns whether the current user follows the user.
void	followTag(Long tagId) Adds the specified tag to the followed items of the current user.
void	followUser(Long userId) Adds the specified user to the followed items of the current user.
void	tagRemoved(Long removedTagId, Long newTagId, List<Long> followers) Method to be called after a tag has been removed or merged with another tag.
void	unfollowBlog(Long blogId) Removes the specified blog/topic from the followed items of the current user.
void	unfollowDiscussion(Long discussionId) Removes the discussion with the specified ID from the followed items of the current user.
void	unfollowDiscussionByNoteId(Long noteId) Removes the discussion of the specified note from the followed items of the current user.
void	unfollowTag(Long tagId) Removes the specified tag from the followed items of the current user.
void	unfollowUser(Long userId) Removes the specified user from the followed items of the current user.

Method Detail

followBlog

void followBlog(Long blogId)
         throws NotFoundException,
                BlogAccessException

Adds the specified blog/topic to the followed items of the current user.

Parameters:

blogId - the ID of the topic to follow

Throws:

NotFoundException - in case the topic does not exist

BlogAccessException - in case the current user has no read access to the topic

followDiscussion

void followDiscussion(Long discussionId)
               throws BlogAccessException,
                      NotFoundException

Adds the discussion with the specified ID to the followed items of the current user.

Parameters:

discussionId - the ID of the discussion to follow

Throws:

NotFoundException - in case the discussion does not exist

BlogAccessException - in case the current user has no read access to the topic of the discussion or the discussion

followDiscussionByNoteId

void followDiscussionByNoteId(Long noteId)
                       throws NotFoundException,
                              BlogAccessException

Adds the discussion of the specified note to the followed items of the current user.

Parameters:

noteId - the ID of the note whose discussion should be followed

Throws:

NotFoundException - in case the discussion does not exist

BlogAccessException - in case the current user has no read access to the topic of the discussion or the discussion

followsBlog

@Transactional(readOnly=true)
boolean followsBlog(Long blogId)

Returns whether the current user follows the blog.

Parameters:

blogId - the ID of the blog

Returns:

true if the blog exists and the current user follows that blog, false otherwise

followsDiscussion

@Transactional(readOnly=true)
boolean followsDiscussion(Long discussionId)

Returns true if the current user follows the discussion, otherwise false.

Parameters:

discussionId - the ID of the discussion

Returns:

true if the discussion exists and the current user follows the discussion, otherwise false

followsTag

@Transactional(readOnly=true)
boolean followsTag(Long id)

Returns true if the current user follows the tag, otherwise false.

Parameters:

id - The ID of the tag.

Returns:

True if the current user follows the given tag.

followsUser

@Transactional(readOnly=true)
boolean followsUser(Long userId)

Returns whether the current user follows the user.

Parameters:

userId - the ID of the user

Returns:

true if the user exists and the current user follows that user, otherwise false

followTag

void followTag(Long tagId)
        throws NotFoundException

Adds the specified tag to the followed items of the current user.

Parameters:

tagId - the ID of the tag to follow

Throws:

NotFoundException - in case the tag does not exist

followUser

void followUser(Long userId)
         throws NotFoundException

Adds the specified user to the followed items of the current user.

Parameters:

userId - ID of the user to follow

Throws:

NotFoundException - in case the user does not exist

tagRemoved

void tagRemoved(Long removedTagId,
                Long newTagId,
                List<Long> followers)
         throws AuthorizationException,
                TagNotFoundException

Method to be called after a tag has been removed or merged with another tag. In case of a merge the provided followers of the old tag will be added as followers to the new tag.

Parameters:

removedTagId - the ID of the removed tag

newTagId - the ID of the tag the old tag was merged into, can be null

followers - the IDs of the users that followed the old tag

Throws:

AuthorizationException - in case the calling user is not the internal system user

TagNotFoundException - in case newTagId is not null but there is no tag for that ID

unfollowBlog

void unfollowBlog(Long blogId)

Removes the specified blog/topic from the followed items of the current user. If the item is not followed nothing will happen.

Parameters:

blogId - the ID of the topic to unfollow

unfollowDiscussion

void unfollowDiscussion(Long discussionId)

Removes the discussion with the specified ID from the followed items of the current user. If the item is not followed nothing will happen.

Parameters:

discussionId - the ID of the discussion to unfollow

unfollowDiscussionByNoteId

void unfollowDiscussionByNoteId(Long noteId)

Removes the discussion of the specified note from the followed items of the current user. If the item is not followed nothing will happen.

Parameters:

noteId - the ID of the note whose discussion should be unfollowed

unfollowTag

void unfollowTag(Long tagId)

Removes the specified tag from the followed items of the current user. If the item is not followed nothing will happen. When unfollowing a tag all tags with the same lower case writing will be unfollowed too.

Parameters:

tagId - the ID of the tag to unfollow

unfollowUser

void unfollowUser(Long userId)

Removes the specified user from the followed items of the current user. If the item is not followed nothing will happen.

Parameters:

userId - ID of the user to follow