public class CategorizationAppSoapStub extends com.collabnet.ce.soap60.webservices.ClientSoapStub implements ICategorizationAppSoap
Constructor and Description |
---|
CategorizationAppSoapStub(String soapServerUrl) |
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
|
public CategorizationAppSoapStub(String soapServerUrl)
public boolean isCategorizationEnabled(String sessionId) throws RemoteException
ICategorizationAppSoap
isCategorizationEnabled
in interface ICategorizationAppSoap
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.RemoteException
public CategorySoapDO createCategory(String sessionId, String parentId, String title, String description) throws RemoteException
ICategorizationAppSoap
createCategory
in interface ICategorizationAppSoap
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 existsRemoteException
public CategorySoapDO getCategoryData(String sessionId, String categoryId) throws RemoteException
ICategorizationAppSoap
getCategoryData
in interface ICategorizationAppSoap
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.RemoteException
public CategorySoapDO getRootCategoryData(String sessionId) throws RemoteException
ICategorizationAppSoap
getRootCategoryData
in interface ICategorizationAppSoap
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.RemoteException
public void setCategoryData(String sessionId, CategorySoapDO categoryData) throws RemoteException
ICategorizationAppSoap
setCategoryData
in interface ICategorizationAppSoap
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.RemoteException
public void deleteCategory(String sessionId, String categoryId) throws RemoteException
ICategorizationAppSoap
deleteCategory
in interface ICategorizationAppSoap
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.RemoteException
public CategorySoapList getAllCategories(String sessionId) throws RemoteException
ICategorizationAppSoap
getAllCategories
in interface ICategorizationAppSoap
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.RemoteException
public CategorySoapList getSubcategories(String sessionId, String categoryId, boolean recursive) throws RemoteException
ICategorizationAppSoap
getSubcategories
in interface ICategorizationAppSoap
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.RemoteException
public void moveCategory(String sessionId, String categoryId, String dstCategoryId) throws RemoteException
ICategorizationAppSoap
moveCategory
in interface ICategorizationAppSoap
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.RemoteException
public void addProjectToCategory(String sessionId, String projectId, String categoryId) throws RemoteException
ICategorizationAppSoap
addProjectToCategory
in interface ICategorizationAppSoap
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.RemoteException
public void removeProjectFromCategory(String sessionId, String projectId, String categoryId) throws RemoteException
ICategorizationAppSoap
removeProjectFromCategory
in interface ICategorizationAppSoap
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.RemoteException
public CategorySoapList getProjectCategories(String sessionId, String projectId) throws RemoteException
ICategorizationAppSoap
getProjectCategories
in interface ICategorizationAppSoap
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.RemoteException
public ProjectSoapList getCategoryProjects(String sessionId, String categoryId, boolean includeSubcategories) throws RemoteException
ICategorizationAppSoap
getCategoryProjects
in interface ICategorizationAppSoap
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.RemoteException
public ProjectSoapList getUncategorizedProjects(String sessionId) throws RemoteException
ICategorizationAppSoap
getUncategorizedProjects
in interface ICategorizationAppSoap
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.RemoteException
Copyright © 2016 CollabNet. All Rights Reserved.