|
Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ForumService
Provides the ability to manipulate forums. This service will allow you to create, delete, move and acquire forums.
Method Summary | |
---|---|
Forum |
createForum(java.lang.String name,
java.lang.String description)
Creates a new forum under the root category. |
Forum |
createForumUnderCategory(java.lang.String name,
java.lang.String description,
long categoryID)
Creates a new forum under the specified category. |
Forum |
createRestrictedForumUnderCategory(java.lang.String name,
java.lang.String description,
long categoryID,
long userID)
Bundles calls associated with creation of a new forum that sets the user as the moderator and sets negative permission for anonymous and registered users. |
void |
deleteForum(long forumID)
Used to delete a forum by its ID. |
void |
deleteProperty(java.lang.String name,
long forumID)
Delete a property with the given name from the forum with the given forum ID. |
Forum |
getForum(long forumID)
Returns a Forum by its ID. |
int |
getForumCount()
Returns the count of all forums in the system. |
int |
getForumCount(long categoryID)
Returns the number of forums under the specified category. |
int |
getForumCountByCategoryIDWithFilter(long categoryID,
ResultFilter resultFilter)
Returns an array of IDs for all forums under this category. |
Forum[] |
getForums()
Returns the IDs of all forums under the root category. |
Forum[] |
getForumsByCategoryID(long categoryID)
Returns an array of IDs for all forums under this category. |
Forum[] |
getForumsByCategoryIDWithFilter(long categoryID,
ResultFilter resultFilter)
Returns an array of IDs for all forums under this category. |
Forum[] |
getPopularForums()
Returns the IDs of all popular forums. |
Property[] |
getProperties(long forumID)
Returns all tbe extended properties for the forum with the forum with specified ID. |
java.lang.String |
getProperty(java.lang.String name,
long forumID)
Returns the value for a given property name. |
int |
getRecursiveForumCount(long categoryID)
Returns the count of all forums under the category with the specified ID. |
Forum[] |
getRecursiveForums(long categoryID)
Returns an array of forum ids for all forums under the category with the specified ID recursively. |
void |
mergeForums(long forumID1,
long forumID2)
Merges the content of two forums by copying the threads from Forum with ID forumID2 to forum with ID forumID1. |
void |
moveForums(long forumID,
long categoryID)
Move the forum with the specified ID to the category with the specified ID. |
void |
setProperty(java.lang.String name,
java.lang.String value,
long forumID)
Set an extended for the property with the given forum ID. |
void |
updateForum(Forum forum)
Updates changes to a forum to the system. |
Method Detail |
---|
Forum getForum(long forumID) throws ForumNotFoundException
Forum
by its ID.
forumID
- The ID of the forum.
ForumNotFoundException
Forum[] getForums()
Forum[] getPopularForums()
int getForumCount()
void deleteForum(long forumID) throws ForumNotFoundException
forumID
- The ID of the forum to delete.
ForumNotFoundException
void mergeForums(long forumID1, long forumID2) throws ForumNotFoundException
forumID1
- The Forum to merge threads into.forumID2
- The Forum to move all threads from.
ForumNotFoundException
void moveForums(long forumID, long categoryID) throws ForumNotFoundException, ForumCategoryNotFoundException
forumID
- The ID of the forum to move.categoryID
- The ID of the category to move the forum to.
ForumNotFoundException
ForumCategoryNotFoundException
Forum[] getRecursiveForums(long categoryID) throws ForumCategoryNotFoundException
categoryID
- The ID of the category to get the ids of the forums.
ForumCategoryNotFoundException
Forum[] getForumsByCategoryID(long categoryID) throws ForumCategoryNotFoundException
categoryID
- The ID of the category to get the ids of the forums.
ForumCategoryNotFoundException
Forum[] getForumsByCategoryIDWithFilter(long categoryID, ResultFilter resultFilter) throws ForumCategoryNotFoundException
categoryID
- The ID of the category to get the ids of the forums.
ForumCategoryNotFoundException
int getRecursiveForumCount(long categoryID) throws ForumCategoryNotFoundException
categoryID
- The ID of the forum to get the ids of the forums .
ForumCategoryNotFoundException
int getForumCountByCategoryIDWithFilter(long categoryID, ResultFilter resultFilter) throws ForumCategoryNotFoundException
categoryID
- The ID of the category to get the ids of the forums.resultFilter
- to filter on.
ForumCategoryNotFoundException
Property[] getProperties(long forumID) throws ForumNotFoundException
forumID
- The ID of the forum to retrieve properties for.
ForumNotFoundException
void deleteProperty(java.lang.String name, long forumID) throws ForumNotFoundException
name
- The name of the property to delete.forumID
- The ID of the forum to delete the property from.
ForumNotFoundException
void setProperty(java.lang.String name, java.lang.String value, long forumID) throws ForumNotFoundException
name
- The name of the property.value
- The value of the property.forumID
- The ID of the forum to set an extended property for.
ForumNotFoundException
java.lang.String getProperty(java.lang.String name, long forumID) throws ForumNotFoundException
name
- the property name.forumID
- the ID of the forum to retrieve the propery for.
ForumNotFoundException
int getForumCount(long categoryID) throws ForumCategoryNotFoundException
categoryID
- The ID of the category.
ForumCategoryNotFoundException
- Thrown if the specified category does not exist.Forum createForum(java.lang.String name, java.lang.String description)
name
- The name of the forum.description
- A short description of the purpose of the forum.
Forum createForumUnderCategory(java.lang.String name, java.lang.String description, long categoryID) throws ForumCategoryNotFoundException
name
- The name of the forum.description
- A short description of the purpose of the forum.categoryID
-
ForumCategoryNotFoundException
- Thrown if the specified category does not exist.void updateForum(Forum forum) throws ForumNotFoundException, NameAlreadyExistsException
forum
- The forum to update.
ForumNotFoundException
NameAlreadyExistsException
Forum createRestrictedForumUnderCategory(java.lang.String name, java.lang.String description, long categoryID, long userID) throws ForumCategoryNotFoundException, UserNotFoundException
name
- description
- categoryID
- userID
-
ForumCategoryNotFoundException
UserNotFoundException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |