|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.webservices.server.ForumCategoryServiceImpl
public class ForumCategoryServiceImpl
Constructor Summary | |
---|---|
ForumCategoryServiceImpl()
|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ForumCategoryServiceImpl()
Method Detail |
---|
public ForumCategory getForumCategory(long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
ForumCategory
by its id
getForumCategory
in interface ForumCategoryService
categoryID
- id of the category
ForumCategoryNotFoundException
public ForumCategory createCategory(java.lang.String name, java.lang.String description)
ForumCategoryService
createCategory
in interface ForumCategoryService
name
- the name of the new category.description
- the description of the new category.
public ForumCategory createSubCategory(java.lang.String name, java.lang.String description, long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
createSubCategory
in interface ForumCategoryService
name
- the name of the new category.description
- the description of the new category.categoryID
- Category to use as the parent
ForumCategoryNotFoundException
public void deleteCategory(long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
deleteCategory
in interface ForumCategoryService
categoryID
- the id of the category to delete
ForumCategoryNotFoundException
public void updateCategory(ForumCategory category) throws ForumCategoryNotFoundException
ForumCategoryService
updateCategory
in interface ForumCategoryService
category
- forum category to update
ForumCategoryNotFoundException
public Property[] getProperties(long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
getProperties
in interface ForumCategoryService
categoryID
- id of the category to retrieve properties for.
ForumCategoryNotFoundException
public void setProperty(java.lang.String name, java.lang.String value, long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
setProperty
in interface ForumCategoryService
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
public java.lang.String getProperty(java.lang.String name, long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
getProperty
in interface ForumCategoryService
name
- the name of the extended propertycategoryID
- the ID of the category to retrieve the propery for.
ForumCategoryNotFoundException
public void deleteProperty(java.lang.String name, long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
deleteProperty
in interface ForumCategoryService
name
- the name of the property to delete.categoryID
- id of the category to delete the property from.
ForumCategoryNotFoundException
public ForumCategory[] getCategoriesByCategoryID(long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
getCategoriesByCategoryID
in interface ForumCategoryService
categoryID
- the id of the category.
ForumCategoryNotFoundException
public int getRecursiveCategoryCount()
ForumCategoryService
getRecursiveCategoryCount
in interface ForumCategoryService
public int getRecursiveCategoryCountByCategoryID(long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
getRecursiveCategoryCountByCategoryID
in interface ForumCategoryService
categoryID
- The id of the category.
ForumCategoryNotFoundException
public ForumCategory[] getRecursiveCategories()
ForumCategoryService
getRecursiveCategories
in interface ForumCategoryService
public ForumCategory[] getRecursiveCategoriesByCategoryID(long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
getRecursiveCategoriesByCategoryID
in interface ForumCategoryService
categoryID
- The id of the category.
ForumCategoryNotFoundException
public Forum[] getRecursiveForums()
ForumCategoryService
getRecursiveForums
in interface ForumCategoryService
public Forum[] getRecursiveForumsByCategoryID(long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
getRecursiveForumsByCategoryID
in interface ForumCategoryService
categoryID
- the id of the category.
ForumCategoryNotFoundException
public Forum[] getRecursiveForumsByCategoryIDWithFilter(long categoryID, ResultFilter resultFilter) throws ForumCategoryNotFoundException
ForumCategoryService
getRecursiveForumsByCategoryIDWithFilter
in interface ForumCategoryService
categoryID
- the id of the category.resultFilter
- to filter on
ForumCategoryNotFoundException
public int getRecursiveForumCount()
ForumCategoryService
getRecursiveForumCount
in interface ForumCategoryService
public int getRecursiveForumCountByCategoryID(long categoryID) throws ForumCategoryNotFoundException
ForumCategoryService
getRecursiveForumCountByCategoryID
in interface ForumCategoryService
ForumCategoryNotFoundException
public int getRecursiveForumCountByCategoryIDWithFilter(long categoryID, ResultFilter resultFilter) throws ForumCategoryNotFoundException
ForumCategoryService
getRecursiveForumCountByCategoryIDWithFilter
in interface ForumCategoryService
categoryID
- * @param resultFilter to filter on
ForumCategoryNotFoundException
public ForumCategory createRestrictedSubCategory(java.lang.String name, java.lang.String description, long categoryID, long userID) throws ForumCategoryNotFoundException, UserNotFoundException
ForumCategoryService
createRestrictedSubCategory
in interface ForumCategoryService
ForumCategoryNotFoundException
UserNotFoundException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |