public interface ICategorizationAppSoap
| Modifier and Type | Method and Description |
|---|---|
void |
addProjectToCategory(String sessionId,
String projectId,
String categoryId)
Adds a given project to a category.
|
CategorySoapDO |
createCategory(String sessionId,
String parentId,
String title,
String description)
Creates a category
|
void |
deleteCategory(String sessionId,
String categoryId)
Deletes an category.
|
CategorySoapList |
getAllCategories(String sessionId)
Returns a list of all categories.
|
CategorySoapDO |
getCategoryData(String sessionId,
String categoryId)
Returns a data object for a given category
|
ProjectSoapList |
getCategoryProjects(String sessionId,
String categoryId,
boolean includeSubcategories)
Gets list of projects in the specified category and, if requested, subcategories
|
CategorySoapList |
getProjectCategories(String sessionId,
String projectId)
Returns a list of categories the project belongs to
|
CategorySoapDO |
getRootCategoryData(String sessionId)
Returns a data object for the root category
|
CategorySoapList |
getSubcategories(String sessionId,
String categoryId,
boolean recursive)
Returns a list of subcategories to the specified category.
|
ProjectSoapList |
getUncategorizedProjects(String sessionId)
Gets list of projects that have not been categorized
|
boolean |
isCategorizationEnabled(String sessionId)
Checks if categorization support is enabled site-wide.
|
void |
moveCategory(String sessionId,
String categoryId,
String dstCategoryId)
Moves a Category including all subcategories under different parent.
|
void |
removeProjectFromCategory(String sessionId,
String projectId,
String categoryId)
Removes a given project from a category.
|
void |
setCategoryData(String sessionId,
CategorySoapDO categoryData)
Sets data on a specific category
|
boolean isCategorizationEnabled(String sessionId) throws RemoteException
sessionId - User session id.com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionCategorySoapDO createCategory(String sessionId, String parentId, String title, String description) throws RemoteException
sessionId - User session id.parentId - ID of the parent categorytitle - Title of the categorydescription - Descriptioncom.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - if an existing category already existsRemoteExceptionCategorySoapDO getCategoryData(String sessionId, String categoryId) throws RemoteException
sessionId - User session id.categoryId - Category id.com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionCategorySoapDO getRootCategoryData(String sessionId) throws RemoteException
sessionId - User session id.com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionvoid setCategoryData(String sessionId, CategorySoapDO categoryData) throws RemoteException
sessionId - User session id.categoryData - Detailed data on the category to set.com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault - when invalid data is specified.com.collabnet.ce.soap60.fault.VersionMismatchFault - when the object version mismatches the application server.RemoteExceptionvoid deleteCategory(String sessionId, String categoryId) throws RemoteException
sessionId - User session id.categoryId - Category id.com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.RemoteExceptionCategorySoapList getAllCategories(String sessionId) throws RemoteException
sessionId - User session id.com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionCategorySoapList getSubcategories(String sessionId, String categoryId, boolean recursive) throws RemoteException
sessionId - User session id.categoryId - category whose immediate subcategories should be returnedrecursive - set to true to get categories recursivelycom.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionvoid moveCategory(String sessionId, String categoryId, String dstCategoryId) throws RemoteException
sessionId - User session id.categoryId - Category to movedstCategoryId - Destination parent categorycom.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionvoid addProjectToCategory(String sessionId, String projectId, String categoryId) throws RemoteException
sessionId - User session id.projectId - ID of the project to add to a categorycategoryId - ID of the category to add the project tocom.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionvoid removeProjectFromCategory(String sessionId, String projectId, String categoryId) throws RemoteException
sessionId - User session id.projectId - ID of the project to remove from a categorycategoryId - ID of the category to remove the project fromcom.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionCategorySoapList getProjectCategories(String sessionId, String projectId) throws RemoteException
sessionId - User session id.projectId - ID of the projectcom.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionProjectSoapList getCategoryProjects(String sessionId, String categoryId, boolean includeSubcategories) throws RemoteException
sessionId - User session id.categoryId - category idincludeSubcategories - boolean, if true, includes projects in subcategoriescom.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionProjectSoapList getUncategorizedProjects(String sessionId) throws RemoteException
sessionId - User session id.com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.RemoteExceptionCopyright © 2016 CollabNet. All Rights Reserved.