|
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 ForumCategoryService
Provides the ability to manipulate forum categories. This service will allow you to create, delete, move and acquire forum categories.
Method Summary | |
---|---|
ForumCategory |
createCategory(java.lang.String name,
java.lang.String description)
Creates a new ForumCategory as a sub-category of the root category using the name and description. |
ForumCategory |
createRestrictedSubCategory(java.lang.String name,
java.lang.String description,
long categoryID,
long userID)
Bundles calls associated with creation of a new sub category that sets the user as the category admin and sets negative permission for anonymous and registered users. |
ForumCategory |
createSubCategory(java.lang.String name,
java.lang.String description,
long categoryID)
Creates a new ForumCategory as a sub-category off of the specified category. |
void |
deleteCategory(long categoryID)
Used to delete the specified category |
void |
deleteProperty(java.lang.String name,
long categoryID)
Delete a property with the given name from the category with the given id. |
ForumCategory[] |
getCategoriesByCategoryID(long categoryID)
Returns the child categories of the category with the given id. |
ForumCategory |
getForumCategory(long categoryID)
Returns a ForumCategory by its id |
Property[] |
getProperties(long categoryID)
Returns all tbe extended properties for the category with the specified id. |
java.lang.String |
getProperty(java.lang.String name,
long categoryID)
Returns the extended property value for the specified name. |
ForumCategory[] |
getRecursiveCategories()
Returns all of the categories in the system recursively. |
ForumCategory[] |
getRecursiveCategoriesByCategoryID(long categoryID)
Returns all of the categories under the specified category recursively. |
int |
getRecursiveCategoryCount()
Returns a count of all the categories in the system. |
int |
getRecursiveCategoryCountByCategoryID(long categoryID)
Returns a count of all the categories under a category |
int |
getRecursiveForumCount()
Returns a count of all the forums in the system. |
int |
getRecursiveForumCountByCategoryID(long categoryID)
Returns a count of all the forums under a category. |
int |
getRecursiveForumCountByCategoryIDWithFilter(long categoryID,
ResultFilter resultFilter)
Returns a count of all the forums under a category. |
Forum[] |
getRecursiveForums()
Returns all of the forums in the system recursively. |
Forum[] |
getRecursiveForumsByCategoryID(long categoryID)
Returns all of the forums under the specified category recursively. |
Forum[] |
getRecursiveForumsByCategoryIDWithFilter(long categoryID,
ResultFilter resultFilter)
Returns all of the forums under the specified category recursively. |
void |
setProperty(java.lang.String name,
java.lang.String value,
long categoryID)
Set an extended propery for the category with the given category id. |
void |
updateCategory(ForumCategory category)
Update a ForumCategory |
Method Detail |
---|
ForumCategory getForumCategory(long categoryID) throws ForumCategoryNotFoundException
ForumCategory
by its id
categoryID
- id of the category
ForumCategoryNotFoundException
ForumCategory createCategory(java.lang.String name, java.lang.String description)
name
- the name of the new category.description
- the description of the new category.
ForumCategory createSubCategory(java.lang.String name, java.lang.String description, long categoryID) throws ForumCategoryNotFoundException
name
- the name of the new category.description
- the description of the new category.categoryID
- Category to use as the parent
ForumCategoryNotFoundException
void deleteCategory(long categoryID) throws ForumCategoryNotFoundException
categoryID
- the id of the category to delete
ForumCategoryNotFoundException
void updateCategory(ForumCategory category) throws ForumCategoryNotFoundException
category
- forum category to update
ForumCategoryNotFoundException
Property[] getProperties(long categoryID) throws ForumCategoryNotFoundException
categoryID
- id of the category to retrieve properties for.
ForumCategoryNotFoundException
void setProperty(java.lang.String name, java.lang.String value, long categoryID) throws ForumCategoryNotFoundException
name
- The name of the property.value
- The value of the property.categoryID
- The ID of the category to set an extended property for.
ForumCategoryNotFoundException
java.lang.String getProperty(java.lang.String name, long categoryID) throws ForumCategoryNotFoundException
name
- the name of the extended propertycategoryID
- the ID of the category to retrieve the propery for.
ForumCategoryNotFoundException
void deleteProperty(java.lang.String name, long categoryID) throws ForumCategoryNotFoundException
name
- the name of the property to delete.categoryID
- id of the category to delete the property from.
ForumCategoryNotFoundException
ForumCategory[] getCategoriesByCategoryID(long categoryID) throws ForumCategoryNotFoundException
categoryID
- the id of the category.
ForumCategoryNotFoundException
ForumCategory[] getRecursiveCategories()
ForumCategory[] getRecursiveCategoriesByCategoryID(long categoryID) throws ForumCategoryNotFoundException
categoryID
- The id of the category.
ForumCategoryNotFoundException
int getRecursiveCategoryCount()
int getRecursiveCategoryCountByCategoryID(long categoryID) throws ForumCategoryNotFoundException
categoryID
- The id of the category.
ForumCategoryNotFoundException
Forum[] getRecursiveForums()
Forum[] getRecursiveForumsByCategoryID(long categoryID) throws ForumCategoryNotFoundException
categoryID
- the id of the category.
ForumCategoryNotFoundException
Forum[] getRecursiveForumsByCategoryIDWithFilter(long categoryID, ResultFilter resultFilter) throws ForumCategoryNotFoundException
categoryID
- the id of the category.resultFilter
- to filter on
ForumCategoryNotFoundException
int getRecursiveForumCount()
int getRecursiveForumCountByCategoryID(long categoryID) throws ForumCategoryNotFoundException
categoryID
-
ForumCategoryNotFoundException
int getRecursiveForumCountByCategoryIDWithFilter(long categoryID, ResultFilter resultFilter) throws ForumCategoryNotFoundException
categoryID
- * @param resultFilter to filter on
ForumCategoryNotFoundException
ForumCategory createRestrictedSubCategory(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 |