ForumService (eXo Platform - Java API Documentation 4.2.1.1 API)

All Superinterfaces:

org.exoplatform.forum.service.ForumServiceLegacy
```
public interface ForumService
extends org.exoplatform.forum.service.ForumServiceLegacy
```
Manages Forums and all its related objects (categories, topics and posts).

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addBanIP(String ip)` Adds an Ip to the list of banned Ips.
`boolean`	`addBanIPForum(String ip, String forumId)` Adds an Ip to the list of banned Ips in a forum.
`void`	`addInitialDataPlugin(org.exoplatform.container.component.ComponentPlugin plugin)` Adds a plugin which initializes data when Forums is started at first time.
`void`	`addInitialDefaultDataPlugin(org.exoplatform.container.component.ComponentPlugin plugin)` Adds a plugin which initializes the default data when Forums is started at first time.
`void`	`addListenerPlugin(org.exoplatform.forum.service.ForumEventListener listener)` Adds a listener plugin.
`void`	`addMember(User user, org.exoplatform.forum.service.UserProfile profileTemplate)` Adds a new member to a forum.
`void`	`addPlugin(org.exoplatform.container.component.ComponentPlugin plugin)` Adds a component plugin which keeps email configuration for Forums.
`void`	`addRolePlugin(org.exoplatform.container.component.ComponentPlugin plugin)` Adds a role plugin which defines role rules in Forums.
`void`	`addTag(List<org.exoplatform.forum.service.Tag> tags, String userName, String topicPath)` Adds a list of tags to a specific topic.
`void`	`addWatch(int watchType, String path, List<String> values, String currentUser)` Adds a watch.
`void`	`calculateDeletedGroup(String groupId, String groupName)` Updates statistics when a group is deleted.
`void`	`calculateDeletedUser(String userName)` Updates statistics when a user is deleted.
`void`	`calculateModerator(String categoryPath, boolean isNew)` Checks information about a moderator of a category.
`long`	`checkPrune(org.exoplatform.forum.service.PruneSetting pSetting)` Checks if settings of a prune is applied to topics or not.
`InputStream`	`createForumRss(String objectId, String link)` Creates an RSS of Forums.
`void`	`createUserProfile(User user)` Creates a new user profile.
`InputStream`	`createUserRss(String userId, String link)` Creates an RSS of a user.
`void`	`evaluateActiveUsers(String query)` Evaluates a list of active users by a query statement.
`Object`	`exportXML(String categoryId, String forumId, List<String> objectIds, String nodePath, ByteArrayOutputStream bos, boolean isExportAll)` Exports data of a category or a forum to an XML file.
`List<org.exoplatform.forum.service.filter.model.CategoryFilter>`	`filterForumByName(String filterKey, String userName, int maxSize)` Gets a list of category filters by a forum name and userName.
`String`	`getActivityIdForOwnerId(String ownerId)` Gets information of a forum activity by the owner Id that is used for processing the activity streams.
`String`	`getActivityIdForOwnerPath(String ownerPath)` Gets information of a forum activity by the owner path that is used for processing the activity streams.
`List<org.exoplatform.forum.service.ForumSearchResult>`	`getAdvancedSearch(org.exoplatform.forum.service.ForumEventQuery eventQuery, List<String> listCateIds, List<String> listForumIds)` Gets an advanced search.
`List<org.exoplatform.forum.service.ForumLinkData>`	`getAllLink(String strQueryCate, String strQueryForum)` Gets all links of a given forum.
`List<org.exoplatform.forum.service.PruneSetting>`	`getAllPruneSetting()` Gets settings of all prunes.
`List<String>`	`getAllTagName(String strQuery, String userAndTopicId)` Gets all tag names by query statement and topic Id.
`List<org.exoplatform.forum.service.Tag>`	`getAllTags()` Gets all tags.
`List<org.exoplatform.forum.service.Topic>`	`getAllTopicsOld(long date, String forumPatch)` Gets a list of topics which were created before a given date.
`long`	`getAvailablePost(String categoryId, String forumId, String topicId, String isApproved, String isHidden, String userLogin)` Gets the number of available posts which match with conditions, including "Approved", "Hidden" and query statement.
`List<String>`	`getBanList()` Gets a list of banned Ips.
`List<String>`	`getBookmarks(String userName)` Gets bookmarks of a user.
`List<org.exoplatform.forum.service.Category>`	`getCategories()` Gets categories in Forums.
`org.exoplatform.forum.service.Category`	`getCategory(String categoryId)` Gets a category by its provided Id.
`org.exoplatform.forum.service.Category`	`getCategoryIncludedSpace()` Gets a category which contains the forum spaces.
`String`	`getCommentIdForOwnerId(String ownerId)` Gets information of a comment by the owner Id.
`String`	`getCommentIdForOwnerPath(String ownerPath)` Gets information of a comment by the owner path.
`org.exoplatform.forum.service.UserProfile`	`getDefaultUserProfile(String userName, String ip)` Gets the default profile information of a user.
`org.exoplatform.forum.service.Forum`	`getForum(String categoryId, String forumId)` Gets a forum by a specific category Id and forum Id.
`org.exoplatform.forum.service.ForumAdministration`	`getForumAdministration()` Gets the administration settings of Forums.
`List<String>`	`getForumBanList(String forumId)` Gets a list of banned Ips in a forum.
`String`	`getForumHomePath()` Gets the home path of a given forum.
`List<org.exoplatform.forum.service.Forum>`	`getForums(org.exoplatform.forum.service.filter.model.ForumFilter filter)` Gets a list forums by filter.
`List<org.exoplatform.forum.service.Forum>`	`getForums(String categoryId, String strQuery)` Deprecated. use `getForums(ForumFilter)`
`org.exoplatform.forum.service.ForumStatistic`	`getForumStatistic()` Gets statistics of Forums.
`org.exoplatform.forum.service.ForumSubscription`	`getForumSubscription(String userId)` Gets information subscribed by a user.
`List<org.exoplatform.forum.service.Forum>`	`getForumSummaries(String categoryId, String strQuery)` Deprecated. use `getForums(ForumFilter)`
`List<org.exoplatform.forum.service.ForumSearchResult>`	`getJobWattingForModerator(String[] paths)` Gets a waiting job which needs to be moderated by the current user.
`int`	`getJobWattingForModeratorByUser(String userId)` Gets the number of waiting jobs which need to be moderated by the current user.
`String`	`getLastLogin()` Gets the last login.
`org.exoplatform.forum.service.Topic`	`getLastPostOfForum(String lastTopicPath)` Gets the last post of a forum.
`long`	`getLastReadIndex(String path, String isApproved, String isHidden, String userLogin)` Gets an index of the last read post in a specific topic.
`org.exoplatform.forum.service.JCRPageList`	`getListPostsByIP(String ip, String strOrderBy)` Gets a list of posts by a given Ip.
`org.exoplatform.forum.service.SendMessageInfo`	`getMessageInfo(String name)` Gets information to build a message.
`List<org.exoplatform.forum.service.Tag>`	`getMyTagInTopic(String[] tagIds)` Gets a list of tags by their Ids.
`List<org.exoplatform.forum.service.Post>`	`getNewPosts(int number)` Gets a list of new public posts with a given limit.
`long`	`getNewPrivateMessage(String userName)` Gets the count of new private messages.
`Object`	`getObjectNameById(String id, String type)` Gets the object name by its path.
`Object`	`getObjectNameByPath(String path)` Gets the object name by its path.
`List<String>`	`getOnlineUsers()` Gets users who are online.
`org.exoplatform.forum.service.JCRPageList`	`getPageListUserProfile()` Deprecated. Use `searchUserProfileByFilter(UserProfileFilter)` instead of.
`org.exoplatform.forum.service.JCRPageList`	`getPagePostByUser(String userName, String userId, boolean isMod, String strOrderBy)` Gets a list of posts by a specific user.
`org.exoplatform.forum.service.JCRPageList`	`getPageTopic(String categoryId, String forumId, String strQuery, String strOrderBy)` Gets a list of topics by a specific category Id, forum Id and query condition.
`org.exoplatform.forum.service.JCRPageList`	`getPageTopicByUser(String userName, boolean isMod, String strOrderBy)` Deprecated. used `getPageTopicByUser(TopicFilter)`
`ListAccess<org.exoplatform.forum.service.Topic>`	`getPageTopicByUser(org.exoplatform.forum.service.impl.model.TopicFilter filter)` Gets a list access of topics by a given userName returned as ListAccess.
`org.exoplatform.forum.service.JCRPageList`	`getPageTopicOld(long date, String forumPatch)` Deprecated. used `getTopicsByDate(long, String)`
`Iterator<org.exoplatform.forum.service.SendMessageInfo>`	`getPendingMessages()` Gets messages which are pending (not sent).
`String[]`	`getPermissionTopicByCategory(String categoryId, String type)` Gets users or groups who have permission to edit topics in a category.
`org.exoplatform.forum.service.Post`	`getPost(String categoryId, String forumId, String topicId, String postId)` Gets a post based on category Id, forum Id, topic Id and post Id.
`org.exoplatform.forum.service.JCRPageList`	`getPostForSplitTopic(String topicPath)` Gets a list of posts in a given topic.
`ListAccess<org.exoplatform.forum.service.Post>`	`getPosts(org.exoplatform.forum.service.impl.model.PostFilter filter)` Gets posts which are returned as ListAccess.
`org.exoplatform.forum.service.JCRPageList`	`getPosts(String categoryId, String forumId, String topicId, String isApproved, String isHidden, String strQuery, String userLogin)` Gets a list of posts in a given forum that match with conditions, including "Approved", "Hidden" and query statement.
`org.exoplatform.forum.service.JCRPageList`	`getPrivateMessage(String userName, String type)` Gets private messages of a user.
`org.exoplatform.forum.service.PruneSetting`	`getPruneSetting(String forumPath)` Gets settings of a prune by a forum path.
`org.exoplatform.forum.service.UserProfile`	`getQuickProfile(String userName)` Gets basic profiles of a user.
`List<org.exoplatform.forum.service.UserProfile>`	`getQuickProfiles(List<String> userList)` Gets basic profiles of users.
`List<org.exoplatform.forum.service.ForumSearchResult>`	`getQuickSearch(String textQuery, String type, String pathQuery, String userId, List<String> listCateIds, List<String> listForumIds, List<String> forumIdsOfModerator)` Gets a quick search.
`List<org.exoplatform.forum.service.Post>`	`getRecentPostsForUser(String userName, int number)` Gets a list of recent posts by a user with a given limit.
`String`	`getScreenName(String userName)` Gets a screen name.
`org.exoplatform.forum.service.Tag`	`getTag(String tagId)` Gets a tag by its Id.
`List<String>`	`getTagNameInTopic(String userAndTopicId)` Gets all tag names in a given topic.
`org.exoplatform.forum.service.Topic`	`getTopic(String categoryId, String forumId, String topicId, String userRead)` Gets a topic by category Id, forum Id and topic Id.
`org.exoplatform.forum.service.JCRPageList`	`getTopicByMyTag(String userIdAndtagId, String strOrderBy)` Gets topics by a given tag.
`org.exoplatform.forum.service.Topic`	`getTopicByPath(String topicPath, boolean isLastPost)` Gets a topic by its path and post condition.
`org.exoplatform.forum.service.LazyPageList<org.exoplatform.forum.service.Topic>`	`getTopicList(String categoryId, String forumId, String string, String strOrderBy, int pageSize)` Gets a list of topics.
`List<org.exoplatform.forum.service.Topic>`	`getTopics(String categoryId, String forumId)` Gets a list of topics by category Id and forum Id.
`ListAccess<org.exoplatform.forum.service.Topic>`	`getTopics(org.exoplatform.forum.service.impl.model.TopicFilter filter)` Gets posts which are returned as ListAccess.
`ListAccess<org.exoplatform.forum.service.Topic>`	`getTopicsByDate(long date, String forumPath)` Gets a list access of topics which were created before a given date.
`org.exoplatform.forum.service.Topic`	`getTopicSummary(String topicPath)` Gets a topic by its path.
`org.exoplatform.forum.service.Topic`	`getTopicUpdate(org.exoplatform.forum.service.Topic topic, boolean isSummary)` Gets more information about a given topic.
`long`	`getTotalTopicOld(long date, String forumPatch)` Gets the total number of topics which were created before a given date.
`org.exoplatform.forum.service.ForumAttachment`	`getUserAvatar(String userName)` Gets an avatar by a given username.
`org.exoplatform.forum.service.UserProfile`	`getUserInfo(String userName)` Gets information about a user.
`org.exoplatform.forum.service.UserProfile`	`getUserInformations(org.exoplatform.forum.service.UserProfile userProfile)` Gets detailed profile information of a user.
`List<String>`	`getUserModerator(String userName, boolean isModeCate)` Gets Ids of forums or categories where the user is moderator.
`org.exoplatform.forum.service.UserProfile`	`getUserProfileManagement(String userName)` Gets the management information of a user profile.
`org.exoplatform.forum.service.UserProfile`	`getUserSettingProfile(String userName)` Gets the profile settings by a user Id.
`List<org.exoplatform.forum.service.Watch>`	`getWatchByUser(String userId)` Gets a list of watches by a user.
`void`	`importXML(String nodePath, ByteArrayInputStream bis, int typeImport)` Imports data into a category or a forum.
`boolean`	`isAdminRole(String userName)` Checks if a user is administrator or not.
`boolean`	`isAdminRoleConfig(String userName)` Checks if a user is administrator or not in the XML configuration.
`boolean`	`isOnline(String userId)` Deprecated. use `UserStateService.isOnline(String)`
`void`	`mergeTopic(String srcTopicPath, String destTopicPath, String mailContent, String link, String topicMergeTitle)` Merges two topics into one.
`void`	`modifyForum(org.exoplatform.forum.service.Forum forum, int type)` Modifies an existing forum with various types.
`void`	`modifyMergedTopic(List<org.exoplatform.forum.service.Topic> topics, int type)` Modifies a list of merged topics with various types.
`void`	`modifyPost(List<org.exoplatform.forum.service.Post> posts, int type)` Modifies a list of posts with various types.
`void`	`modifyTopic(List<org.exoplatform.forum.service.Topic> topics, int type)` Modifies a list of topics with various types.
`void`	`moveForum(List<org.exoplatform.forum.service.Forum> forums, String destCategoryPath)` Moves a list of forums to a specific category.
`void`	`movePost(String[] postPaths, String destTopicPath, boolean isCreatNewTopic, String mailContent, String link)` Moves a list of posts to a given topic.
`void`	`moveTopic(List<org.exoplatform.forum.service.Topic> topics, String destForumPath, String mailContent, String link)` Moves a list of topics to a forum.
`void`	`removeBan(String ip)` Removes a banned Ip.
`void`	`removeBanIPForum(String ip, String forumId)` Removes an Ip from the list of banned Ips in a forum.
`void`	`removeCacheUserProfile(String userName)` Removes data of user profile from cache of a user.
`org.exoplatform.forum.service.Category`	`removeCategory(String categoryId)` Removes a category by its provided Id.
`org.exoplatform.forum.service.Forum`	`removeForum(String categoryId, String forumId)` Removes a forum by its category Id and forum Id.
`void`	`removeMember(User user)` Removes an existing member from a forum.
`org.exoplatform.forum.service.Post`	`removePost(String categoryId, String forumId, String topicId, String postId)` Removes a post.
`void`	`removePrivateMessage(String messageId, String userName, String type)` Removes a private message.
`org.exoplatform.forum.service.Topic`	`removeTopic(String categoryId, String forumId, String topicId)` Removes a topic.
`void`	`removeWatch(int watchType, String path, String values)` Removes a watch.
`void`	`runPrune(org.exoplatform.forum.service.PruneSetting pSetting)` Runs settings of a prune.
`void`	`runPrune(String forumPath)` Runs settings of a prune by a forum path.
`void`	`saveActivityIdForOwnerId(String ownerId, String activityId)` Saves information of a forum activity by the owner Id that is used for processing the activity streams.
`void`	`saveActivityIdForOwnerPath(String ownerPath, String activityId)` Saves information of a forum activity by the owner path that is used for processing the activity streams.
`void`	`saveCategory(org.exoplatform.forum.service.Category category, boolean isNew)` Saves a category which is added or updated.
`void`	`saveCollapsedCategories(String userName, String categoryId, boolean isAdd)` Saves a collapsed category.
`void`	`saveCommentIdForOwnerId(String ownerId, String commentId)` Saves information of a comment by the owner Id.
`void`	`saveCommentIdForOwnerPath(String ownerPath, String commentId)` Saves information of a comment by the owner path.
`void`	`saveForum(String categoryId, org.exoplatform.forum.service.Forum forum, boolean isNew)` Saves a forum into a specific category.
`void`	`saveForumAdministration(org.exoplatform.forum.service.ForumAdministration forumAdministration)` Saves the administration settings of Forums.
`void`	`saveForumStatistic(org.exoplatform.forum.service.ForumStatistic forumStatistic)` Saves statistics of Forums.
`void`	`saveForumSubscription(org.exoplatform.forum.service.ForumSubscription forumSubscription, String userId)` Saves a subscription of a user.
`void`	`saveLastPostIdRead(String userId, String[] lastReadPostOfForum, String[] lastReadPostOfTopic)` Saves Ids of the last read posts into a topic or forum.
`void`	`saveModerateOfForums(List<String> forumPaths, String userName, boolean isDelete)` Saves or removes a moderator to/from a list of forums.
`void`	`saveModOfCategory(List<String> moderatorCate, String userId, boolean isAdd)` Sets a moderator for a category.
`void`	`savePost(String categoryId, String forumId, String topicId, org.exoplatform.forum.service.Post post, boolean isNew, org.exoplatform.forum.service.MessageBuilder messageBuilder)` Saves or updates a post.
`void`	`savePrivateMessage(org.exoplatform.forum.service.ForumPrivateMessage privateMessage)` Saves a private message.
`void`	`savePruneSetting(org.exoplatform.forum.service.PruneSetting pruneSetting)` Saves settings of a prune.
`void`	`saveReadMessage(String messageId, String userName, String type)` Saves a read message.
`void`	`saveTag(org.exoplatform.forum.service.Tag newTag)` Saves a new tag.
`void`	`saveTopic(String categoryId, String forumId, org.exoplatform.forum.service.Topic topic, boolean isNew, boolean isMove, org.exoplatform.forum.service.MessageBuilder messageBuilder)` Saves or updates a topic by category Id and forum Id.
`void`	`saveUserAvatar(String userId, org.exoplatform.forum.service.ForumAttachment fileAttachment)` Saves an avatar for a user.
`void`	`saveUserBookmark(String userName, String bookMark, boolean isNew)` Saves a user's bookmark.
`void`	`saveUserModerator(String userName, List<String> ids, boolean isModeCate)` Sets the moderator role to a user in a forum or a category.
`void`	`saveUserProfile(org.exoplatform.forum.service.UserProfile userProfile, boolean isOption, boolean isBan)` Saves the user profile.
`void`	`saveUserSettingProfile(org.exoplatform.forum.service.UserProfile userProfile)` Saves the settings information of a user profile.
`javax.jcr.NodeIterator`	`search(String queryString)` Searches by a query statement.
`org.exoplatform.forum.service.JCRPageList`	`searchUserProfile(String userSearch)` Deprecated. Use `searchUserProfileByFilter(UserProfileFilter)` instead of.
`ListAccess<org.exoplatform.forum.service.UserProfile>`	`searchUserProfileByFilter(org.exoplatform.forum.service.impl.model.UserProfileFilter userProfileFilter)` Searches for user profiles return as ListAccess.
`void`	`setDefaultAvatar(String userName)` Sets a default avatar.
`void`	`setViewCountTopic(String path, String userRead)` Counts the number of topic viewers.
`void`	`splitTopic(org.exoplatform.forum.service.Topic newTopic, org.exoplatform.forum.service.Post firstPost, List<String> postPathMove, String mailContent, String link)` Splits a topic into 2 ones.
`void`	`unTag(String tagId, String userName, String topicPath)` Removes a tag from a given topic.
`void`	`updateEmailWatch(List<String> listNodeId, String newEmailAdd, String userId)` Updates an email address of a watch for a user.
`void`	`updateForum(String path)` Updates information of a forum.
`void`	`updateForumAccess(String userId, String forumId)` Updates the access information to a forum of a user.
`void`	`updateLoggedinUsers()` Updates information of logged-in users.
`void`	`updateLoggedinUsers(String repoName)`
`void`	`updateStatisticCounts(long topicCoutn, long postCount)` Updates information about topics and posts.
`void`	`updateTopicAccess(String userId, String topicId)` Updates the access information to a topic of a user.
`void`	`updateUserProfile(User user)` Saves the user profile.
`void`	`updateUserProfileInfo(String name)` Updates the user profile information.
`org.exoplatform.forum.service.UserProfile`	`updateUserProfileSetting(org.exoplatform.forum.service.UserProfile userProfile)` Updates settings of the user profile.
`void`	`userLogin(String userId)` Sets the login information of a user.
`void`	`userLogin(String repoName, String userId)`
`void`	`userLogout(String userId)` Sets the logout information of a user.
`void`	`writeReads()` Marks topics which have been read, then saves them into the user profile.
`void`	`writeViews()` Saves the number of topic viewers.

- Method Detail
  - addPlugin
```
void addPlugin(org.exoplatform.container.component.ComponentPlugin plugin)
               throws Exception
```
    Adds a component plugin which keeps email configuration for Forums.
    
    Parameters:
    plugin - The plugin to be added.
    
    Throws:
    
    Exception - the exception
    Since:
    
    1.0.x
    
    Level API:
    
    Platform
  - addRolePlugin
```
void addRolePlugin(org.exoplatform.container.component.ComponentPlugin plugin)
                   throws Exception
```
    Adds a role plugin which defines role rules in Forums.
    
    Parameters:
    plugin - The plugin to be added.
    
    Throws:
    
    Exception - the exception
    Since:
    
    1.0.x
    
    Level API:
    
    Platform
  - addInitialDataPlugin
```
void addInitialDataPlugin(org.exoplatform.container.component.ComponentPlugin plugin)
                          throws Exception
```
    Adds a plugin which initializes data when Forums is started at first time.
    
    Parameters:
    plugin - The plugin to be added.
    
    Throws:
    
    Exception - the exception
    Since:
    
    1.0.x
    
    Level API:
    
    Platform
  - addInitialDefaultDataPlugin
```
void addInitialDefaultDataPlugin(org.exoplatform.container.component.ComponentPlugin plugin)
                                 throws Exception
```
    Adds a plugin which initializes the default data when Forums is started at first time.
    
    Parameters:
    plugin - The plugin to be added.
    
    Throws:
    
    Exception
    Level API:
    
    Platform
  - getCategories
```
List<org.exoplatform.forum.service.Category> getCategories()
```
    Gets categories in Forums.
    
    Returns:
    Categories.
    Level API:
    
    Platform
  - getCategory
```
org.exoplatform.forum.service.Category getCategory(String categoryId)
```
    Gets a category by its provided Id.
    
    Parameters:
    categoryId - Id of the category.
    
    Returns:
    A category.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getCategoryIncludedSpace
```
org.exoplatform.forum.service.Category getCategoryIncludedSpace()
```
    Gets a category which contains the forum spaces.
    
    Returns:
    A category.
    
    Throws:
    
    Exception
    Level API:
    
    Platform
  - getPermissionTopicByCategory
```
String[] getPermissionTopicByCategory(String categoryId,
                                    String type)
                                      throws Exception
```
    Gets users or groups who have permission to edit topics in a category.
    
    Parameters:
    categoryId - Id of the category.
    type - Type of the category.
    
    Throws:
    
    Exception - the exception
    Since:
    
    1.2.x
    
    Level API:
    
    Platform
  - saveCategory
```
void saveCategory(org.exoplatform.forum.service.Category category,
                boolean isNew)
                  throws Exception
```
    Saves a category which is added or updated.
    
    Parameters:
    category - The category to be saved.
    isNew - If "true", the new category is added. If "false", the category is updated.
    
    Throws:
    
    Exception - the exception
    Since:
    
    1.0.x
    
    Level API:
    
    Platform
  - calculateModerator
```
void calculateModerator(String categoryPath,
                      boolean isNew)
                        throws Exception
```
    Checks information about a moderator of a category.
    
    Parameters:
    categoryPath - Path to the category.
    isNew - If "true", the new information is added. If "false", the information is updated.
    
    Throws:
    
    Exception - the exception
    Since:
    
    1.2.x
    
    Level API:
    
    Platform
  - saveModOfCategory
```
void saveModOfCategory(List<String> moderatorCate,
                     String userId,
                     boolean isAdd)
```
    Sets a moderator for a category.
    
    Parameters:
    moderatorCate - The moderator.
    userId - Id of the moderator.
    isAdd - If "true", the moderator is added. If "false", the moderator is removed.
    
    Throws:
    
    Exception - the exception
    Since:
    
    1.2.x
    
    Level API:
    
    Platform
  - removeCategory
```
org.exoplatform.forum.service.Category removeCategory(String categoryId)
                                                      throws Exception
```
    Removes a category by its provided Id.
    
    Parameters:
    categoryId - Id of the category to be removed.
    
    Returns:
    The removed category.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getForums
```
List<org.exoplatform.forum.service.Forum> getForums(String categoryId,
                                                  String strQuery)
                                                    throws Exception
```
    Deprecated. use getForums(ForumFilter)
    
    Gets a list of forums by a specific category Id and a query condition.
    
    Parameters:
    categoryId - Id of the category.
    strQuery - The query condition.
    
    Returns:
    Forums.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getForumSummaries
```
List<org.exoplatform.forum.service.Forum> getForumSummaries(String categoryId,
                                                          String strQuery)
                                                            throws Exception
```
    Deprecated. use getForums(ForumFilter)
    
    Gets summaries of Forums.
    
    Parameters:
    categoryId - Id of the category.
    strQuery - The statement to query forums.
    
    Returns:
    The list of forums.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getForums
```
List<org.exoplatform.forum.service.Forum> getForums(org.exoplatform.forum.service.filter.model.ForumFilter filter)
```
    Gets a list forums by filter.
    
    Parameters:
    userName - Name of the user.
    filter - The condition to get forums.
    
    Returns:
    The forums.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - filterForumByName
```
List<org.exoplatform.forum.service.filter.model.CategoryFilter> filterForumByName(String filterKey,
                                                                                String userName,
                                                                                int maxSize)
                                                                                  throws Exception
```
    Gets a list of category filters by a forum name and userName.
    
    Parameters:
    filterKey - The key to search for a forum.
    userName - Name of the user.
    maxSize - The maximum number of category filters which are returned.
    
    Returns:
    Category filters.
    
    Throws:
    
    Exception
    Level API:
    
    Platform
  - getForum
```
org.exoplatform.forum.service.Forum getForum(String categoryId,
                                           String forumId)
```
    Gets a forum by a specific category Id and forum Id.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    
    Returns:
    The forum.
    Level API:
    
    Platform
  - modifyForum
```
void modifyForum(org.exoplatform.forum.service.Forum forum,
               int type)
                 throws Exception
```
    Modifies an existing forum with various types.
    - 1. Utils.CLOSE: Closes a given forum.
    - 2. Utils.LOCK: Locks a given forum.
    - 3. Utils.APPROVE: Approves a given forum.
    - 4. Utils.STICKY: Sticks a given forum.
    - 5. Utils.ACTIVE: Activates a given forum.
    - 6. Utils.WAITING: Waits for a given forum.
    - 7. Utils.HIDDEN: Hides a given forum.
    Parameters:
    forum - The forum to be modified.
    type - A type to modify the forum.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveForum
```
void saveForum(String categoryId,
             org.exoplatform.forum.service.Forum forum,
             boolean isNew)
               throws Exception
```
    Saves a forum into a specific category.
    
    Parameters:
    categoryId - Id of the category.
    forum - The forum to be saved.
    isNew - If "true", the new forum is added. If "false", the forum is updated.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveModerateOfForums
```
void saveModerateOfForums(List<String> forumPaths,
                        String userName,
                        boolean isDelete)
                          throws Exception
```
    Saves or removes a moderator to/from a list of forums.
    
    Parameters:
    forumPaths - Paths to the forums.
    userName - Name of the moderator.
    isDelete - If "true", the modertator is removed. If "false", the moderator is added.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - removeForum
```
org.exoplatform.forum.service.Forum removeForum(String categoryId,
                                              String forumId)
                                                throws Exception
```
    Removes a forum by its category Id and forum Id.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum to be removed.
    
    Returns:
    The forum
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - moveForum
```
void moveForum(List<org.exoplatform.forum.service.Forum> forums,
             String destCategoryPath)
               throws Exception
```
    Moves a list of forums to a specific category.
    
    Parameters:
    forums - Forums to be moved.
    destCategoryPath - Path to the target category.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPageTopic
```
org.exoplatform.forum.service.JCRPageList getPageTopic(String categoryId,
                                                     String forumId,
                                                     String strQuery,
                                                     String strOrderBy)
                                                       throws Exception
```
    Gets a list of topics by a specific category Id, forum Id and query condition.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    strQuery - The query condition.
    strOrderBy - The returned topics are shown by the ascending or descending order.
    
    Returns:
    Topics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPageTopicByUser
```
org.exoplatform.forum.service.JCRPageList getPageTopicByUser(String userName,
                                                           boolean isMod,
                                                           String strOrderBy)
                                                             throws Exception
```
    Deprecated. used getPageTopicByUser(TopicFilter)
    
    Gets a list of topics by a given username.
    
    Parameters:
    userName - Name of the user.
    isMod - If "true", only topics moderated by the user is returned.
    strOrderBy - The order type for topics (ascending or descending).
    
    Returns:
    Topics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPageTopicByUser
```
ListAccess<org.exoplatform.forum.service.Topic> getPageTopicByUser(org.exoplatform.forum.service.impl.model.TopicFilter filter)
                                                                   throws Exception
```
    Gets a list access of topics by a given userName returned as ListAccess.
    
    Parameters:
    userName - Name of the user.
    filter - The condition to get posts.
    
    Returns:
    The topics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPageTopicOld
```
org.exoplatform.forum.service.JCRPageList getPageTopicOld(long date,
                                                        String forumPatch)
                                                          throws Exception
```
    Deprecated. used getTopicsByDate(long, String)
    
    Gets a list of topics which were created before a given date.
    
    Parameters:
    date - The given date.
    forumPatch - Path to the forum which contains topics.
    
    Returns:
    Topics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getTopicsByDate
```
ListAccess<org.exoplatform.forum.service.Topic> getTopicsByDate(long date,
                                                              String forumPath)
                                                                throws Exception
```
    Gets a list access of topics which were created before a given date.
    
    Parameters:
    date - The given date.
    forumPatch - Path to the forum which contains topics.
    
    Returns:
    Topics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getAllTopicsOld
```
List<org.exoplatform.forum.service.Topic> getAllTopicsOld(long date,
                                                        String forumPatch)
                                                          throws Exception
```
    Gets a list of topics which were created before a given date.
    
    Parameters:
    date - The given date.
    forumPatch - Path to the forum which contains topics.
    
    Returns:
    Topics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getTotalTopicOld
```
long getTotalTopicOld(long date,
                    String forumPatch)
```
    Gets the total number of topics which were created before a given date.
    
    Parameters:
    date - The given date.
    forumPatch - Path to the forum which contains topics.
    
    Returns:
    The total number of topics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getTopics
```
List<org.exoplatform.forum.service.Topic> getTopics(String categoryId,
                                                  String forumId)
                                                    throws Exception
```
    Gets a list of topics by category Id and forum Id.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    
    Returns:
    A lis of topics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getTopic
```
org.exoplatform.forum.service.Topic getTopic(String categoryId,
                                           String forumId,
                                           String topicId,
                                           String userRead)
                                             throws Exception
```
    Gets a topic by category Id, forum Id and topic Id.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    topicId - Id of the topic.
    userRead - The user who views the topic.
    
    Returns:
    The topic.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getTopics
```
ListAccess<org.exoplatform.forum.service.Topic> getTopics(org.exoplatform.forum.service.impl.model.TopicFilter filter)
                                                          throws Exception
```
    Gets posts which are returned as ListAccess.
    
    Parameters:
    filter - The condition to get posts.
    
    Returns:
    The posts.
    
    Throws:
    
    Exception
    Since:
    
    2.2.11
  - setViewCountTopic
```
void setViewCountTopic(String path,
                     String userRead)
```
    Counts the number of topic viewers.
    
    Parameters:
    path - Path to the topic.
    userRead - The user who views the topic.
    Level API:
    
    Platform
  - writeViews
```
void writeViews()
```
    Saves the number of topic viewers.
    
    Since:
    
    2.2.11
  - getTopicByPath
```
org.exoplatform.forum.service.Topic getTopicByPath(String topicPath,
                                                 boolean isLastPost)
                                                   throws Exception
```
    Gets a topic by its path and post condition.
    
    Parameters:
    topicPath - Path to the topic.
    isLastPost - If "true", the returned topic is one which has the last post.
    
    Returns:
    The topic.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getLastPostOfForum
```
org.exoplatform.forum.service.Topic getLastPostOfForum(String lastTopicPath)
                                                       throws Exception
```
    Gets the last post of a forum.
    
    Parameters:
    lastTopicPath - Path to the topic which contains the last post.
    
    Returns:
    The topic which contains the last post.
    
    Throws:
    
    Exception
    Level API:
    
    Platform
  - getTopicSummary
```
org.exoplatform.forum.service.Topic getTopicSummary(String topicPath)
                                                    throws Exception
```
    Gets a topic by its path.
    
    Parameters:
    topicPath - Path to the topic.
    
    Returns:
    The topic.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getTopicUpdate
```
org.exoplatform.forum.service.Topic getTopicUpdate(org.exoplatform.forum.service.Topic topic,
                                                 boolean isSummary)
                                                   throws Exception
```
    Gets more information about a given topic.
    
    Parameters:
    topic - The topic which is required to have more information.
    isSummary - If "true", the summary information about the topic is included.
    
    Returns:
    The topic.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - modifyTopic
```
void modifyTopic(List<org.exoplatform.forum.service.Topic> topics,
               int type)
```
    Modifies a list of topics with various types.
    - 1. Utils.CLOSE: Closes a given topic.
    - 2. Utils.LOCK: Locks a given topic.
    - 3. Utils.APPROVE: Approves a given topic.
    - 4. Utils.STICKY: Sticks a given topic.
    - 5. Utils.ACTIVE: Activates a given topic.
    - 6. Utils.WAITING: Waits for a given topic.
    - 7. Utils.HIDDEN: Hides a given topic.
    Parameters:
    topics - Topics to be modified.
    type - The selected modification type.
    Level API:
    
    Platform
  - modifyMergedTopic
```
void modifyMergedTopic(List<org.exoplatform.forum.service.Topic> topics,
                     int type)
```
    Modifies a list of merged topics with various types.
    - 1. Utils.CLOSE: Closes the given list of merged topics.
    - 2. Utils.LOCK: Locks the given list of merged topics.
    - 3. Utils.APPROVE: Approves the given list of merged topics.
    - 4. Utils.STICKY: Sticks the given list of merged topics.
    - 5. Utils.ACTIVE: Activates the given list of merged topics.
    - 6. Utils.WAITING: Waits for the given list of merged topics.
    - 7. Utils.HIDDEN: Hides the given list of merged topics.
    Parameters:
    topics - Merged topics.
    type - The selected modification type.
    Level API:
    
    Platform
  - saveTopic
```
void saveTopic(String categoryId,
             String forumId,
             org.exoplatform.forum.service.Topic topic,
             boolean isNew,
             boolean isMove,
             org.exoplatform.forum.service.MessageBuilder messageBuilder)
               throws Exception
```
    Saves or updates a topic by category Id and forum Id.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    topic - The topic to be saved or updated.
    isNew - If "true", the new topic is added. If "false", the topic is updated.
    isMove - If "true", the topic is moved.
    messageBuilder - Builds an email message.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - removeTopic
```
org.exoplatform.forum.service.Topic removeTopic(String categoryId,
                                              String forumId,
                                              String topicId)
                                                throws Exception
```
    Removes a topic.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    topicId - Id of the topic.
    
    Returns:
    The topic.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - moveTopic
```
void moveTopic(List<org.exoplatform.forum.service.Topic> topics,
             String destForumPath,
             String mailContent,
             String link)
               throws Exception
```
    Moves a list of topics to a forum.
    
    Parameters:
    topics - Topics to be moved.
    destForumPath - Path to the target forum.
    mailContent - Content of the email notification.
    link - Link to a specific topic.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - mergeTopic
```
void mergeTopic(String srcTopicPath,
              String destTopicPath,
              String mailContent,
              String link,
              String topicMergeTitle)
                throws Exception
```
    Merges two topics into one.
    
    Parameters:
    srcTopicPath - Path to the source topic.
    destTopicPath - Path to the target topic.
    mailContent - Content of the email notification.
    link - Link to a specific topic.
    topicMergeTitle - Title of new topic which has been merged.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - splitTopic
```
void splitTopic(org.exoplatform.forum.service.Topic newTopic,
              org.exoplatform.forum.service.Post firstPost,
              List<String> postPathMove,
              String mailContent,
              String link)
                throws Exception
```
    Splits a topic into 2 ones.
    
    Parameters:
    newTopic - The new topic which is created after being split.
    firstPost - The fist post of the new topic.
    postPathMove - Path to the post which is moved to the topic.
    mailContent - Content of the email notification.
    link - Link to the new topic.
    
    Throws:
    
    Exception
    Since:
    
    4.0
    
    Level API:
    
    Platform
  - getPosts
```
org.exoplatform.forum.service.JCRPageList getPosts(String categoryId,
                                                 String forumId,
                                                 String topicId,
                                                 String isApproved,
                                                 String isHidden,
                                                 String strQuery,
                                                 String userLogin)
                                                   throws Exception
```
    Gets a list of posts in a given forum that match with conditions, including "Approved", "Hidden" and query statement.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    topicId - Id of the topic.
    isApproved - If "true", only approved posts are returned.
    isHidden - If "true", only hidden posts are returned.
    strQuery - The query statement.
    userLogin - Name of the user who logs in.
    
    Returns:
    Posts.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPostForSplitTopic
```
org.exoplatform.forum.service.JCRPageList getPostForSplitTopic(String topicPath)
                                                               throws Exception
```
    Gets a list of posts in a given topic.
    
    Parameters:
    topicPath - Path to the topic.
    
    Returns:
    Posts.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPosts
```
ListAccess<org.exoplatform.forum.service.Post> getPosts(org.exoplatform.forum.service.impl.model.PostFilter filter)
                                                        throws Exception
```
    Gets posts which are returned as ListAccess.
    
    Parameters:
    filter - The condition to get posts.
    
    Returns:
    The posts.
    
    Throws:
    
    Exception
    Since:
    
    2.2.11
  - getAvailablePost
```
long getAvailablePost(String categoryId,
                    String forumId,
                    String topicId,
                    String isApproved,
                    String isHidden,
                    String userLogin)
                      throws Exception
```
    Gets the number of available posts which match with conditions, including "Approved", "Hidden" and query statement.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    topicId - Id of the topic.
    isApproved - If "true", only approved posts are returned.
    isHidden - If "true", only hidden posts are returned.
    userLogin - Name of the user who logs in.
    
    Returns:
    The number of available posts.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getLastReadIndex
```
long getLastReadIndex(String path,
                    String isApproved,
                    String isHidden,
                    String userLogin)
                      throws Exception
```
    Gets an index of the last read post in a specific topic.
    
    Parameters:
    path - Path to the post.
    isApproved - If "true", the last read post must be an approved one.
    isHidden - If "true", the last read post must be a hidden one.
    userLogin - Name of the user who logs in.
    
    Returns:
    The post index.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPagePostByUser
```
org.exoplatform.forum.service.JCRPageList getPagePostByUser(String userName,
                                                          String userId,
                                                          boolean isMod,
                                                          String strOrderBy)
                                                            throws Exception
```
    Gets a list of posts by a specific user.
    
    Parameters:
    userName - Name of the current viewer.
    userId - Id of the poster.
    isMod - If "true", the poster is moderator.
    strOrderBy - The order type for posts (ascending or descending).
    
    Returns:
    Posts.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPost
```
org.exoplatform.forum.service.Post getPost(String categoryId,
                                         String forumId,
                                         String topicId,
                                         String postId)
                                           throws Exception
```
    Gets a post based on category Id, forum Id, topic Id and post Id.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    topicId - Id of the topic.
    postId - Id of the post.
    
    Returns:
    The post.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - savePost
```
void savePost(String categoryId,
            String forumId,
            String topicId,
            org.exoplatform.forum.service.Post post,
            boolean isNew,
            org.exoplatform.forum.service.MessageBuilder messageBuilder)
              throws Exception
```
    Saves or updates a post.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    topicId - Id of the topic.
    post - The post.
    isNew - If "true", the new post is added. If "false", the post is updated.
    messageBuilder - Builds an email message.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - modifyPost
```
void modifyPost(List<org.exoplatform.forum.service.Post> posts,
              int type)
```
    Modifies a list of posts with various types.
    - 1. Utils.CLOSE: Closes the given post.
    - 2. Utils.LOCK: Locks the given post.
    - 3. Utils.APPROVE: Approves the given post.
    - 4. Utils.STICKY: Sticks the given post.
    - 5. Utils.ACTIVE: Activates the given post.
    - 6. Utils.WAITING: Waits for the given post.
    - 7. Utils.HIDDEN: Hides the given post.
    Parameters:
    posts - The posts.
    type - The modification type.
    Level API:
    
    Platform
  - removePost
```
org.exoplatform.forum.service.Post removePost(String categoryId,
                                            String forumId,
                                            String topicId,
                                            String postId)
```
    Removes a post.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    topicId - Id of the topic.
    postId - Id of the post.
    
    Returns:
    The post.
    Level API:
    
    Platform
  - movePost
```
void movePost(String[] postPaths,
            String destTopicPath,
            boolean isCreatNewTopic,
            String mailContent,
            String link)
              throws Exception
```
    Moves a list of posts to a given topic.
    
    Parameters:
    postPaths - Paths to the moved posts.
    destTopicPath - Path to the destination topic.
    isCreatNewTopic - If "true", the new topic is created. If "false", the topic is updated.
    mailContent - Content of the email notification.
    link - Link to the topic.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getObjectNameByPath
```
Object getObjectNameByPath(String path)
                           throws Exception
```
    Gets the object name by its path.
    
    Parameters:
    path - Path to the object name.
    
    Returns:
    The object name.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getObjectNameById
```
Object getObjectNameById(String id,
                       String type)
                         throws Exception
```
    Gets the object name by its path.
    
    Parameters:
    id - Identity to get the object name.
    type - Type of the object.
    
    Returns:
    The object name.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getAllLink
```
List<org.exoplatform.forum.service.ForumLinkData> getAllLink(String strQueryCate,
                                                           String strQueryForum)
                                                             throws Exception
```
    Gets all links of a given forum.
    
    Parameters:
    strQueryCate - The query condition of the category.
    strQueryForum - The query condition of the forum.
    
    Returns:
    All links.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getForumHomePath
```
String getForumHomePath()
                        throws Exception
```
    Gets the home path of a given forum.
    
    Returns:
    The home path.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - addTag
```
void addTag(List<org.exoplatform.forum.service.Tag> tags,
          String userName,
          String topicPath)
            throws Exception
```
    Adds a list of tags to a specific topic.
    
    Parameters:
    tags - Tags to be added.
    userName - Name of the current viewer.
    topicPath - Path to the topic.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - unTag
```
void unTag(String tagId,
         String userName,
         String topicPath)
```
    Removes a tag from a given topic.
    
    Parameters:
    tagId - Id of the tag to be removed.
    userName - Name of the current viewer.
    topicPath - Path to the topic.
    Level API:
    
    Platform
  - getTag
```
org.exoplatform.forum.service.Tag getTag(String tagId)
                                         throws Exception
```
    Gets a tag by its Id.
    
    Parameters:
    tagId - Id of the tag.
    
    Returns:
    The tag.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getAllTagName
```
List<String> getAllTagName(String strQuery,
                         String userAndTopicId)
                           throws Exception
```
    Gets all tag names by query statement and topic Id.
    
    Parameters:
    strQuery - The query statement.
    userAndTopicId - The 'userId,topicId' pattern.
    
    Returns:
    Tag names.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getTagNameInTopic
```
List<String> getTagNameInTopic(String userAndTopicId)
                               throws Exception
```
    Gets all tag names in a given topic.
    
    Parameters:
    userAndTopicId - The 'userId,topicId' pattern.
    
    Returns:
    The tag names.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getAllTags
```
List<org.exoplatform.forum.service.Tag> getAllTags()
                                                   throws Exception
```
    Gets all tags.
    
    Returns:
    The tags.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getMyTagInTopic
```
List<org.exoplatform.forum.service.Tag> getMyTagInTopic(String[] tagIds)
                                                        throws Exception
```
    Gets a list of tags by their Ids.
    
    Parameters:
    tagIds - Ids of the tags.
    
    Returns:
    The tags.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getTopicByMyTag
```
org.exoplatform.forum.service.JCRPageList getTopicByMyTag(String userIdAndtagId,
                                                        String strOrderBy)
                                                          throws Exception
```
    Gets topics by a given tag.
    
    Parameters:
    userIdAndtagId - The 'userId:tagId' pattern.
    strOrderBy - The order type for topics (ascending or descending).
    
    Returns:
    The topics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveTag
```
void saveTag(org.exoplatform.forum.service.Tag newTag)
             throws Exception
```
    Saves a new tag.
    
    Parameters:
    newTag - The tag to be saved.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveUserProfile
```
void saveUserProfile(org.exoplatform.forum.service.UserProfile userProfile,
                   boolean isOption,
                   boolean isBan)
                     throws Exception
```
    Saves the user profile.
    
    Parameters:
    userProfile - The user profile to be saved.
    isOption - If "true", only some basic information is saved. If "false", all information is saved.
    isBan - If "true", the profile of the banned user is still saved.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - updateUserProfile
```
void updateUserProfile(User user)
                       throws Exception
```
    Saves the user profile.
    
    Parameters:
    user - The user who wants to update his profile.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveUserModerator
```
void saveUserModerator(String userName,
                     List<String> ids,
                     boolean isModeCate)
                       throws Exception
```
    Sets the moderator role to a user in a forum or a category.
    
    Parameters:
    userName - Name of the user.
    ids - Ids in the forum or category.
    isModeCate - If "true", the moderator role of the category is set to the user. If "false", the moderator role of the forum is set to set to the user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - searchUserProfile
```
org.exoplatform.forum.service.JCRPageList searchUserProfile(String userSearch)
                                                            throws Exception
```
    Deprecated. Use searchUserProfileByFilter(UserProfileFilter) instead of.
    
    Searches for a user profile.
    
    Parameters:
    userSearch - The user who wants to search.
    
    Returns:
    A list of user profiles.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - searchUserProfileByFilter
```
ListAccess<org.exoplatform.forum.service.UserProfile> searchUserProfileByFilter(org.exoplatform.forum.service.impl.model.UserProfileFilter userProfileFilter)
                                                                                throws Exception
```
    Searches for user profiles return as ListAccess.
    
    Parameters:
    userProfileFilter - The filter object
    
    Returns:
    A ListAccess of user profiles.
    
    Throws:
    
    Exception - the exception
    Since:
    
    4.0.5
    
    Level API:
    
    Platform
  - getUserInfo
```
org.exoplatform.forum.service.UserProfile getUserInfo(String userName)
                                                      throws Exception
```
    Gets information about a user.
    
    Parameters:
    userName - Name of the user.
    
    Returns:
    The user information.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getUserModerator
```
List<String> getUserModerator(String userName,
                            boolean isModeCate)
                              throws Exception
```
    Gets Ids of forums or categories where the user is moderator.
    
    Parameters:
    userName - Name of the user.
    isModeCate - If "true", Ids of categories are returned. If "false", Ids of forums are returned.
    
    Returns:
    Ids.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveUserBookmark
```
void saveUserBookmark(String userName,
                    String bookMark,
                    boolean isNew)
                      throws Exception
```
    Saves a user's bookmark.
    
    Parameters:
    userName - Name of the user who bookmarks.
    bookMark - The bookmark to be saved.
    isNew - If "true", the new bookmark is added. If "false", the bookmark is updated.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveLastPostIdRead
```
void saveLastPostIdRead(String userId,
                      String[] lastReadPostOfForum,
                      String[] lastReadPostOfTopic)
                        throws Exception
```
    Saves Ids of the last read posts into a topic or forum.
    
    Parameters:
    userId - Name of the current user.
    lastReadPostOfForum - The number of the last read posts in a forum.
    lastReadPostOfTopic - The number of the last read posts in a topic.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveCollapsedCategories
```
void saveCollapsedCategories(String userName,
                           String categoryId,
                           boolean isAdd)
                             throws Exception
```
    Saves a collapsed category.
    
    Parameters:
    userName - Name of the current user.
    categoryId - Id of the collapsed category.
    isAdd - If "true", the new collapsed category is added. If "false", the collapsed category is updated.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPageListUserProfile
```
org.exoplatform.forum.service.JCRPageList getPageListUserProfile()
                                                                 throws Exception
```
    Deprecated. Use searchUserProfileByFilter(UserProfileFilter) instead of.
    
    Gets all user profiles.
    
    Returns:
    A list of user profiles.
    
    Throws:
    
    Exception - the exception.
    Level API:
    
    Platform
  - getQuickSearch
```
List<org.exoplatform.forum.service.ForumSearchResult> getQuickSearch(String textQuery,
                                                                   String type,
                                                                   String pathQuery,
                                                                   String userId,
                                                                   List<String> listCateIds,
                                                                   List<String> listForumIds,
                                                                   List<String> forumIdsOfModerator)
                                                                     throws Exception
```
    Gets a quick search.
    
    Parameters:
    textQuery - The text query.
    type - Type of object to search (forum, topic or post).
    pathQuery - The path by which the quick search is performed.
    userId - The user who performs the quick search.
    listCateIds - A list of categories where the quick search is performed.
    listForumIds - A list of forums where the quick search is performed.
    forumIdsOfModerator - Ids of the forums where the user is moderator.
    
    Returns:
    A list of search results.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getScreenName
```
String getScreenName(String userName)
                     throws Exception
```
    Gets a screen name.
    
    Parameters:
    userName - Name of the user.
    
    Returns:
    The screen name.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getAdvancedSearch
```
List<org.exoplatform.forum.service.ForumSearchResult> getAdvancedSearch(org.exoplatform.forum.service.ForumEventQuery eventQuery,
                                                                      List<String> listCateIds,
                                                                      List<String> listForumIds)
```
    Gets an advanced search.
    
    Parameters:
    eventQuery - The search condition.
    listCateIds - A list of categories where the advanced search is performed.
    listForumIds - A list of forums where the advanced search is performed.
    
    Returns:
    A list of search results.
    Level API:
    
    Platform
  - saveForumStatistic
```
void saveForumStatistic(org.exoplatform.forum.service.ForumStatistic forumStatistic)
                        throws Exception
```
    Saves statistics of Forums.
    
    Parameters:
    forumStatistic - The Forums statistics to be saved.
    
    Throws:
    
    Exception - the exception.
    Level API:
    
    Platform
  - getForumStatistic
```
org.exoplatform.forum.service.ForumStatistic getForumStatistic()
                                                               throws Exception
```
    Gets statistics of Forums.
    
    Returns:
    The Forums statistics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveForumAdministration
```
void saveForumAdministration(org.exoplatform.forum.service.ForumAdministration forumAdministration)
                             throws Exception
```
    Saves the administration settings of Forums.
    
    Parameters:
    forumAdministration - The Forums administration settings to be saved.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getForumAdministration
```
org.exoplatform.forum.service.ForumAdministration getForumAdministration()
                                                                         throws Exception
```
    Gets the administration settings of Forums.
    
    Returns:
    Information about the Forum administration settings.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - updateStatisticCounts
```
void updateStatisticCounts(long topicCoutn,
                         long postCount)
                           throws Exception
```
    Updates information about topics and posts.
    
    Parameters:
    topicCoutn - The number of topics.
    postCount - The number of posts.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - userLogin
```
void userLogin(String userId)
               throws Exception
```
    Sets the login information of a user.
    
    Parameters:
    userId - Id of the current user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - userLogin
```
void userLogin(String repoName,
             String userId)
               throws Exception
```
    Throws:
    
    Exception
  - userLogout
```
void userLogout(String userId)
                throws Exception
```
    Sets the logout information of a user.
    
    Parameters:
    userId - Id of the user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - isOnline
```
boolean isOnline(String userId)
                 throws Exception
```
    Deprecated. use UserStateService.isOnline(String)
    
    Checks if a user is online or not.
    
    Parameters:
    userId - Id of the user.
    
    Returns:
    If "true", the checked user is online.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getOnlineUsers
```
List<String> getOnlineUsers()
                            throws Exception
```
    Gets users who are online.
    
    Returns:
    The online users.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getLastLogin
```
String getLastLogin()
                    throws Exception
```
    Gets the last login.
    
    Returns:
    Id of the user who did the last login.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPrivateMessage
```
org.exoplatform.forum.service.JCRPageList getPrivateMessage(String userName,
                                                          String type)
                                                            throws Exception
```
    Gets private messages of a user.
    
    Parameters:
    userName - Name of the user.
    type - Two message types: Sent or Received.
    
    Returns:
    Private messages.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getNewPrivateMessage
```
long getNewPrivateMessage(String userName)
                          throws Exception
```
    Gets the count of new private messages.
    
    Parameters:
    userName - Name of the user.
    
    Returns:
    The count of new private messages.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - savePrivateMessage
```
void savePrivateMessage(org.exoplatform.forum.service.ForumPrivateMessage privateMessage)
                        throws Exception
```
    Saves a private message.
    
    Parameters:
    privateMessage - The private message to be saved.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveReadMessage
```
void saveReadMessage(String messageId,
                   String userName,
                   String type)
                     throws Exception
```
    Saves a read message.
    
    Parameters:
    messageId - Id of the message to be saved.
    userName - Name of the current user.
    type - Two message types: Sent or Received.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - removePrivateMessage
```
void removePrivateMessage(String messageId,
                        String userName,
                        String type)
                          throws Exception
```
    Removes a private message.
    
    Parameters:
    messageId - Id of the message.
    userName - Name of the current user.
    type - Two message types: Sent or Received.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getForumSubscription
```
org.exoplatform.forum.service.ForumSubscription getForumSubscription(String userId)
```
    Gets information subscribed by a user.
    
    Parameters:
    userId - Id of the current user.
    
    Returns:
    The subscription information.
    Level API:
    
    Platform
  - saveForumSubscription
```
void saveForumSubscription(org.exoplatform.forum.service.ForumSubscription forumSubscription,
                         String userId)
                           throws Exception
```
    Saves a subscription of a user.
    
    Parameters:
    forumSubscription - The subscription information to be saved.
    userId - Id of the current user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - addWatch
```
void addWatch(int watchType,
            String path,
            List<String> values,
            String currentUser)
              throws Exception
```
    Adds a watch.
    
    Parameters:
    watchType - Type of watch (RSS or Email).
    path - Path to the watched object.
    values - Content of the email notification.
    currentUser - Information about the current user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - removeWatch
```
void removeWatch(int watchType,
               String path,
               String values)
                 throws Exception
```
    Removes a watch.
    
    Parameters:
    watchType - Type of watch (RSS or Email).
    path - Path to the unwatched object.
    values - The value to remove.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getJobWattingForModerator
```
List<org.exoplatform.forum.service.ForumSearchResult> getJobWattingForModerator(String[] paths)
```
    Gets a waiting job which needs to be moderated by the current user.
    
    Parameters:
    paths - Paths in Forums where the user is moderator.
    
    Returns:
    Topics and posts which are waiting for the moderator to validate.
    Level API:
    
    Platform
  - getJobWattingForModeratorByUser
```
int getJobWattingForModeratorByUser(String userId)
                                    throws Exception
```
    Gets the number of waiting jobs which need to be moderated by the current user.
    
    Parameters:
    userId - Id of the user.
    
    Returns:
    The number of waiting jobs.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getMessageInfo
```
org.exoplatform.forum.service.SendMessageInfo getMessageInfo(String name)
                                                             throws Exception
```
    Gets information to build a message.
    
    Parameters:
    name - Name of the message.
    
    Returns:
    The message information.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPendingMessages
```
Iterator<org.exoplatform.forum.service.SendMessageInfo> getPendingMessages()
                                                                           throws Exception
```
    Gets messages which are pending (not sent).
    
    Returns:
    The pending messages.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - isAdminRole
```
boolean isAdminRole(String userName)
                    throws Exception
```
    Checks if a user is administrator or not.
    
    Parameters:
    userName - Id of the checked user.
    
    Returns:
    The returned value is "true" if the user is administrator.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - isAdminRoleConfig
```
boolean isAdminRoleConfig(String userName)
                          throws Exception
```
    Checks if a user is administrator or not in the XML configuration.
    
    Parameters:
    userName - Id of the checked user.
    
    Returns:
    The returned value is "true" if the user is administrator.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getNewPosts
```
List<org.exoplatform.forum.service.Post> getNewPosts(int number)
                                                     throws Exception
```
    Gets a list of new public posts with a given limit.
    
    Parameters:
    number - The limit size.
    
    Returns:
    New public posts.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getRecentPostsForUser
```
List<org.exoplatform.forum.service.Post> getRecentPostsForUser(String userName,
                                                             int number)
                                                               throws Exception
```
    Gets a list of recent posts by a user with a given limit.
    
    Parameters:
    userName - Id of the user.
    number - The limit size.
    
    Returns:
    The recent posts.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - search
```
javax.jcr.NodeIterator search(String queryString)
                              throws Exception
```
    Searches by a query statement.
    
    Parameters:
    queryString - The query statement.
    
    Returns:
    The nodes.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - evaluateActiveUsers
```
void evaluateActiveUsers(String query)
```
    Evaluates a list of active users by a query statement.
    
    Parameters:
    query - The query statement.
    Level API:
    
    Platform
  - createUserProfile
```
void createUserProfile(User user)
                       throws Exception
```
    Creates a new user profile.
    
    Parameters:
    user - The user whose profile is created.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - updateTopicAccess
```
void updateTopicAccess(String userId,
                     String topicId)
```
    Updates the access information to a topic of a user.
    
    Parameters:
    userId - Id of the user.
    topicId - Id of the topic.
    Level API:
    
    Platform
  - updateForumAccess
```
void updateForumAccess(String userId,
                     String forumId)
```
    Updates the access information to a forum of a user.
    
    Parameters:
    userId - Id of the user.
    forumId - Id of the forum.
    Level API:
    
    Platform
  - writeReads
```
void writeReads()
```
    Marks topics which have been read, then saves them into the user profile.
    
    Since:
    
    2.2.11
  - exportXML
```
Object exportXML(String categoryId,
               String forumId,
               List<String> objectIds,
               String nodePath,
               ByteArrayOutputStream bos,
               boolean isExportAll)
                 throws Exception
```
    Exports data of a category or a forum to an XML file.
    
    Parameters:
    categoryId - Id of the category.
    forumId - Id of the forum.
    objectIds - Id of the category or forum.
    nodePath - Path to the category or forum which is exported.
    bos - The input byte stream. If this value is null, the output is a zip-typed file.
    isExportAll - If "true", all is exported.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - importXML
```
void importXML(String nodePath,
             ByteArrayInputStream bis,
             int typeImport)
               throws Exception
```
    Imports data into a category or a forum.
    
    Parameters:
    nodePath - Path to the data which is imported.
    bis - The input stream to import.
    typeImport - Type of import. Refer to ImportUUIDBehavior.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getQuickProfiles
```
List<org.exoplatform.forum.service.UserProfile> getQuickProfiles(List<String> userList)
                                                                 throws Exception
```
    Gets basic profiles of users.
    
    Parameters:
    userList - Users.
    
    Returns:
    The profiles.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getQuickProfile
```
org.exoplatform.forum.service.UserProfile getQuickProfile(String userName)
                                                          throws Exception
```
    Gets basic profiles of a user.
    
    Parameters:
    userName - Id of the user.
    
    Returns:
    Profile information of the user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getUserInformations
```
org.exoplatform.forum.service.UserProfile getUserInformations(org.exoplatform.forum.service.UserProfile userProfile)
                                                              throws Exception
```
    Gets detailed profile information of a user.
    
    Parameters:
    userProfile - The profile information of the user.
    
    Returns:
    The detailed profile information of the user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getDefaultUserProfile
```
org.exoplatform.forum.service.UserProfile getDefaultUserProfile(String userName,
                                                              String ip)
                                                                throws Exception
```
    Gets the default profile information of a user.
    
    Parameters:
    userName - Id of the user.
    ip - Ip of the user.
    
    Returns:
    The default profile information.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - updateUserProfileSetting
```
org.exoplatform.forum.service.UserProfile updateUserProfileSetting(org.exoplatform.forum.service.UserProfile userProfile)
                                                                   throws Exception
```
    Updates settings of the user profile.
    
    Parameters:
    userProfile - The input user profile.
    
    Returns:
    The updated settings of the user profile.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getBookmarks
```
List<String> getBookmarks(String userName)
                          throws Exception
```
    Gets bookmarks of a user.
    
    Parameters:
    userName - Id of the user.
    
    Returns:
    Bookmarks.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getUserSettingProfile
```
org.exoplatform.forum.service.UserProfile getUserSettingProfile(String userName)
                                                                throws Exception
```
    Gets the profile settings by a user Id.
    
    Parameters:
    userName - Id of the user.
    
    Returns:
    Profile information of the user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getUserProfileManagement
```
org.exoplatform.forum.service.UserProfile getUserProfileManagement(String userName)
                                                                   throws Exception
```
    Gets the management information of a user profile.
    
    Parameters:
    userName - Id of the user.
    
    Returns:
    Profile information of the user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveUserSettingProfile
```
void saveUserSettingProfile(org.exoplatform.forum.service.UserProfile userProfile)
                            throws Exception
```
    Saves the settings information of a user profile.
    
    Parameters:
    userProfile - The user profile information to be saved.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - updateForum
```
void updateForum(String path)
                 throws Exception
```
    Updates information of a forum.
    
    Parameters:
    path - Path to the forum.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getBanList
```
List<String> getBanList()
                        throws Exception
```
    Gets a list of banned Ips.
    
    Returns:
    The banned Ips.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - addBanIP
```
boolean addBanIP(String ip)
                 throws Exception
```
    Adds an Ip to the list of banned Ips.
    
    Parameters:
    ip - Ip to be added.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - removeBan
```
void removeBan(String ip)
               throws Exception
```
    Removes a banned Ip.
    
    Parameters:
    ip - Ip to be removed.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getForumBanList
```
List<String> getForumBanList(String forumId)
                             throws Exception
```
    Gets a list of banned Ips in a forum.
    
    Parameters:
    forumId - Id of the forum.
    
    Returns:
    The banned Ips in the forum.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - addBanIPForum
```
boolean addBanIPForum(String ip,
                    String forumId)
                      throws Exception
```
    Adds an Ip to the list of banned Ips in a forum.
    
    Parameters:
    ip - Ip to be added.
    forumId - Id of the forum.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - removeBanIPForum
```
void removeBanIPForum(String ip,
                    String forumId)
                      throws Exception
```
    Removes an Ip from the list of banned Ips in a forum.
    
    Parameters:
    ip - Ip to be removed.
    forumId - Id of the forum.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getListPostsByIP
```
org.exoplatform.forum.service.JCRPageList getListPostsByIP(String ip,
                                                         String strOrderBy)
                                                           throws Exception
```
    Gets a list of posts by a given Ip.
    
    Parameters:
    ip - Ip to get the list of posts.
    strOrderBy - The returned posts are shown in the ascending or descending order.
    
    Returns:
    The posts.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getUserAvatar
```
org.exoplatform.forum.service.ForumAttachment getUserAvatar(String userName)
                                                            throws Exception
```
    Gets an avatar by a given username.
    
    Parameters:
    userName - Id of the user.
    
    Returns:
    The user avatar.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - saveUserAvatar
```
void saveUserAvatar(String userId,
                  org.exoplatform.forum.service.ForumAttachment fileAttachment)
                    throws Exception
```
    Saves an avatar for a user.
    
    Parameters:
    userId - Id of the user.
    fileAttachment - The avatar data to be saved.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - setDefaultAvatar
```
void setDefaultAvatar(String userName)
```
    Sets a default avatar.
    
    Parameters:
    userName - Id of the user.
    Level API:
    
    Platform
  - getWatchByUser
```
List<org.exoplatform.forum.service.Watch> getWatchByUser(String userId)
                                                         throws Exception
```
    Gets a list of watches by a user.
    
    Parameters:
    userId - Id of the user.
    
    Returns:
    The watches.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - updateEmailWatch
```
void updateEmailWatch(List<String> listNodeId,
                    String newEmailAdd,
                    String userId)
                      throws Exception
```
    Updates an email address of a watch for a user.
    
    Parameters:
    listNodeId - A list of Ids of the watched nodes.
    newEmailAdd - The new email address to be updated.
    userId - Id of the user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getAllPruneSetting
```
List<org.exoplatform.forum.service.PruneSetting> getAllPruneSetting()
                                                                    throws Exception
```
    Gets settings of all prunes.
    
    Returns:
    Settings of all prunes.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getPruneSetting
```
org.exoplatform.forum.service.PruneSetting getPruneSetting(String forumPath)
                                                           throws Exception
```
    Gets settings of a prune by a forum path.
    
    Parameters:
    forumPath - Path to the forum.
    
    Returns:
    Settings information of the prune.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - savePruneSetting
```
void savePruneSetting(org.exoplatform.forum.service.PruneSetting pruneSetting)
                      throws Exception
```
    Saves settings of a prune.
    
    Parameters:
    pruneSetting - The prune settings to be saved.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - runPrune
```
void runPrune(org.exoplatform.forum.service.PruneSetting pSetting)
              throws Exception
```
    Runs settings of a prune.
    
    Parameters:
    pSetting - The prune setting to be run.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - runPrune
```
void runPrune(String forumPath)
              throws Exception
```
    Runs settings of a prune by a forum path.
    
    Parameters:
    forumPath - Path to the forum.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - checkPrune
```
long checkPrune(org.exoplatform.forum.service.PruneSetting pSetting)
                throws Exception
```
    Checks if settings of a prune is applied to topics or not.
    
    Parameters:
    pSetting - The prune settings to be checked.
    
    Returns:
    The number of topics to be pruned.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - getTopicList
```
org.exoplatform.forum.service.LazyPageList<org.exoplatform.forum.service.Topic> getTopicList(String categoryId,
                                                                                           String forumId,
                                                                                           String string,
                                                                                           String strOrderBy,
                                                                                           int pageSize)
                                                                                             throws Exception
```
    Gets a list of topics.
    
    Parameters:
    categoryId - Id of the category containing the topics.
    forumId - Id of the forum.
    string - The input condition.
    strOrderBy - The returned topics are shown in the ascending or descending order.
    pageSize - The limit size to get topics.
    
    Returns:
    Topics.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - updateUserProfileInfo
```
void updateUserProfileInfo(String name)
                           throws Exception
```
    Updates the user profile information.
    
    Parameters:
    name - Id of the user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - addMember
```
void addMember(User user,
             org.exoplatform.forum.service.UserProfile profileTemplate)
               throws Exception
```
    Adds a new member to a forum. The forum profile is created and its statistics is updated.
    
    Parameters:
    user - The user to be added.
    profileTemplate - The user profile template to be used for default settings.
    
    Throws:
    
    Exception
    Level API:
    
    Platform
  - removeMember
```
void removeMember(User user)
                  throws Exception
```
    Removes an existing member from a forum. The forum profile is deleted and its statistics is updated.
    
    Parameters:
    user - The user who is removed from the forum.
    
    Throws:
    
    Exception
    Level API:
    
    Platform
  - updateLoggedinUsers
```
void updateLoggedinUsers()
                         throws Exception
```
    Updates information of logged-in users.
    
    Throws:
    
    Exception
    Level API:
    
    Platform
  - updateLoggedinUsers
```
void updateLoggedinUsers(String repoName)
                         throws Exception
```
    Throws:
    
    Exception
  - calculateDeletedUser
```
void calculateDeletedUser(String userName)
                          throws Exception
```
    Updates statistics when a user is deleted.
    
    Parameters:
    userName - Id of the removed user.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - calculateDeletedGroup
```
void calculateDeletedGroup(String groupId,
                         String groupName)
                           throws Exception
```
    Updates statistics when a group is deleted.
    
    Parameters:
    groupId - Id of the deleted group.
    groupName - Name of the deleted group.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - createForumRss
```
InputStream createForumRss(String objectId,
                         String link)
                           throws Exception
```
    Creates an RSS of Forums.
    
    Parameters:
    objectId - Id of any object which needs to create RSS (forum, topic).
    link - The link to get RSS.
    
    Returns:
    RSS data information.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - createUserRss
```
InputStream createUserRss(String userId,
                        String link)
                          throws Exception
```
    Creates an RSS of a user.
    
    Parameters:
    userId - Id of the user.
    link - The link to get the RSS.
    
    Returns:
    RSS data information.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - addListenerPlugin
```
void addListenerPlugin(org.exoplatform.forum.service.ForumEventListener listener)
                       throws Exception
```
    Adds a listener plugin.
    
    Parameters:
    listener - The forum listener to be added.
    
    Throws:
    
    Exception - the exception
    Level API:
    
    Platform
  - removeCacheUserProfile
```
void removeCacheUserProfile(String userName)
                            throws Exception
```
    Removes data of user profile from cache of a user.
    
    Parameters:
    userName - Id of the user.
    
    Throws:
    
    Exception
    Level API:
    
    Platform
  - saveActivityIdForOwnerId
```
void saveActivityIdForOwnerId(String ownerId,
                            String activityId)
```
    Saves information of a forum activity by the owner Id that is used for processing the activity streams.
    
    Parameters:
    ownerId - Id of the user who has created the forum activity.
    activityId - Id of the forum activity.
    Since:
    
    4.0
    
    Level API:
    
    Platform
  - saveActivityIdForOwnerPath
```
void saveActivityIdForOwnerPath(String ownerPath,
                              String activityId)
```
    Saves information of a forum activity by the owner path that is used for processing the activity streams.
    
    Parameters:
    ownerPath - Path to the user who has created the forum activity.
    activityId - Id of the forum activity.
    Since:
    
    4.0
    
    Level API:
    
    Platform
  - getActivityIdForOwnerId
```
String getActivityIdForOwnerId(String ownerId)
```
    Gets information of a forum activity by the owner Id that is used for processing the activity streams.
    
    Parameters:
    ownerId - Id of the user who has created the forum activity.
    
    Returns:
    Id of the forum activity.
    Since:
    
    4.0
    
    Level API:
    
    Platform
  - getActivityIdForOwnerPath
```
String getActivityIdForOwnerPath(String ownerPath)
```
    Gets information of a forum activity by the owner path that is used for processing the activity streams.
    
    Parameters:
    ownerPath - Path to the user who has created the forum activity.
    
    Returns:
    Id of the forum activity.
    Since:
    
    4.0
    
    Level API:
    
    Platform
  - saveCommentIdForOwnerId
```
void saveCommentIdForOwnerId(String ownerId,
                           String commentId)
```
    Saves information of a comment by the owner Id.
    
    Parameters:
    ownerId - Id of the user who has commented.
    commentId - Id of the comment.
    Since:
    
    4.0
    
    Level API:
    
    Platform
  - saveCommentIdForOwnerPath
```
void saveCommentIdForOwnerPath(String ownerPath,
                             String commentId)
```
    Saves information of a comment by the owner path.
    
    Parameters:
    ownerPath - Path to the user who has commented.
    commentId - Id of the comment.
    Since:
    
    4.0
    
    Level API:
    
    Platform
  - getCommentIdForOwnerId
```
String getCommentIdForOwnerId(String ownerId)
```
    Gets information of a comment by the owner Id.
    
    Parameters:
    ownerId - Id of the user who has commented.
    
    Returns:
    Id of the comment.
    Since:
    
    4.0
    
    Level API:
    
    Platform
  - getCommentIdForOwnerPath
```
String getCommentIdForOwnerPath(String ownerPath)
```
    Gets information of a comment by the owner path.
    
    Parameters:
    ownerPath - Path to the user who has commented.
    
    Returns:
    Id of the comment.
    Since:
    
    4.0
    
    Level API:
    
    Platform

Interface ForumService

Method Summary

Method Detail

addPlugin

addRolePlugin

addInitialDataPlugin

addInitialDefaultDataPlugin

getCategories

getCategory

getCategoryIncludedSpace

getPermissionTopicByCategory

saveCategory

calculateModerator

saveModOfCategory

removeCategory

getForums

getForumSummaries

getForums

filterForumByName

getForum

modifyForum

saveForum

saveModerateOfForums

removeForum

moveForum

getPageTopic

getPageTopicByUser

getPageTopicByUser

getPageTopicOld

getTopicsByDate

getAllTopicsOld

getTotalTopicOld

getTopics

getTopic

getTopics

setViewCountTopic

writeViews

getTopicByPath

getLastPostOfForum

getTopicSummary

getTopicUpdate

modifyTopic

modifyMergedTopic

saveTopic

removeTopic

moveTopic

mergeTopic

splitTopic

getPosts

getPostForSplitTopic

getPosts

getAvailablePost

getLastReadIndex

getPagePostByUser

getPost

savePost

modifyPost

removePost

movePost

getObjectNameByPath

getObjectNameById

getAllLink

getForumHomePath

addTag

unTag

getTag

getAllTagName

getTagNameInTopic

getAllTags

getMyTagInTopic

getTopicByMyTag

saveTag

saveUserProfile

updateUserProfile

saveUserModerator

searchUserProfile

searchUserProfileByFilter

getUserInfo

getUserModerator

saveUserBookmark