Class CategorizationAppSoapStub
java.lang.Object
com.collabnet.ce.soap60.webservices.ClientSoapStub
com.collabnet.ce.soap60.webservices.categorization.CategorizationAppSoapStub
- All Implemented Interfaces:
ICategorizationAppSoap
-
Field Summary
Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
DEFAULT_CLIENT_TIME_OUT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addProjectToCategory
(String sessionId, String projectId, String categoryId) Adds a given project to a category.createCategory
(String sessionId, String parentId, String title, String description) Creates a categoryvoid
deleteCategory
(String sessionId, String categoryId) Deletes an category.getAllCategories
(String sessionId) Returns a list of all categories.getCategoryData
(String sessionId, String categoryId) Returns a data object for a given categorygetCategoryProjects
(String sessionId, String categoryId, boolean includeSubcategories) Gets list of projects in the specified category and, if requested, subcategoriesgetProjectCategories
(String sessionId, String projectId) Returns a list of categories the project belongs togetRootCategoryData
(String sessionId) Returns a data object for the root categorygetSubcategories
(String sessionId, String categoryId, boolean recursive) Returns a list of subcategories to the specified category.getUncategorizedProjects
(String sessionId) Gets list of projects that have not been categorizedboolean
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 categoryMethods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam
-
Constructor Details
-
CategorizationAppSoapStub
-
-
Method Details
-
isCategorizationEnabled
Description copied from interface:ICategorizationAppSoap
Checks if categorization support is enabled site-wide.- Specified by:
isCategorizationEnabled
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.- Returns:
- true/false
- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
createCategory
public CategorySoapDO createCategory(String sessionId, String parentId, String title, String description) throws RemoteException Description copied from interface:ICategorizationAppSoap
Creates a category- Specified by:
createCategory
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.parentId
- ID of the parent categorytitle
- Title of the categorydescription
- Description- Returns:
- A category data object representing the newly created category
- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.NoSuchObjectFault
- when the specified object id is invalid.ObjectAlreadyExistsFault
- if an existing category already existsRemoteException
-
getCategoryData
Description copied from interface:ICategorizationAppSoap
Returns a data object for a given category- Specified by:
getCategoryData
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.categoryId
- Category id.- Returns:
- Detailed data on the category.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
getRootCategoryData
Description copied from interface:ICategorizationAppSoap
Returns a data object for the root category- Specified by:
getRootCategoryData
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.- Returns:
- Detailed data on the root category.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
setCategoryData
Description copied from interface:ICategorizationAppSoap
Sets data on a specific category- Specified by:
setCategoryData
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.categoryData
- Detailed data on the category to set.- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.IllegalArgumentFault
- when invalid data is specified.VersionMismatchFault
- when the object version mismatches the application server.RemoteException
-
deleteCategory
Description copied from interface:ICategorizationAppSoap
Deletes an category.- Specified by:
deleteCategory
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.categoryId
- Category id.- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system level error occurs.RemoteException
-
getAllCategories
Description copied from interface:ICategorizationAppSoap
Returns a list of all categories.- Specified by:
getAllCategories
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.- Returns:
- List of categories within the project.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
getSubcategories
public CategorySoapList getSubcategories(String sessionId, String categoryId, boolean recursive) throws RemoteException Description copied from interface:ICategorizationAppSoap
Returns a list of subcategories to the specified category.- Specified by:
getSubcategories
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.categoryId
- category whose immediate subcategories should be returnedrecursive
- set to true to get categories recursively- Returns:
- List of categories in the root category.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
moveCategory
public void moveCategory(String sessionId, String categoryId, String dstCategoryId) throws RemoteException Description copied from interface:ICategorizationAppSoap
Moves a Category including all subcategories under different parent. Fails completely if not everything can be moved.- Specified by:
moveCategory
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.categoryId
- Category to movedstCategoryId
- Destination parent category- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
addProjectToCategory
public void addProjectToCategory(String sessionId, String projectId, String categoryId) throws RemoteException Description copied from interface:ICategorizationAppSoap
Adds a given project to a category.- Specified by:
addProjectToCategory
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.projectId
- ID of the project to add to a categorycategoryId
- ID of the category to add the project to- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.ObjectAlreadyExistsFault
- when the specified object id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
removeProjectFromCategory
public void removeProjectFromCategory(String sessionId, String projectId, String categoryId) throws RemoteException Description copied from interface:ICategorizationAppSoap
Removes a given project from a category.- Specified by:
removeProjectFromCategory
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.projectId
- ID of the project to remove from a categorycategoryId
- ID of the category to remove the project from- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.RemoteException
-
getProjectCategories
public CategorySoapList getProjectCategories(String sessionId, String projectId) throws RemoteException Description copied from interface:ICategorizationAppSoap
Returns a list of categories the project belongs to- Specified by:
getProjectCategories
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.projectId
- ID of the project- Returns:
- List of categories the project is in
- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.NoSuchObjectFault
- when the specified object id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
getCategoryProjects
public ProjectSoapList getCategoryProjects(String sessionId, String categoryId, boolean includeSubcategories) throws RemoteException Description copied from interface:ICategorizationAppSoap
Gets list of projects in the specified category and, if requested, subcategories- Specified by:
getCategoryProjects
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.categoryId
- category idincludeSubcategories
- boolean, if true, includes projects in subcategories- Returns:
- List of projects that are in the category
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-
getUncategorizedProjects
Description copied from interface:ICategorizationAppSoap
Gets list of projects that have not been categorized- Specified by:
getUncategorizedProjects
in interfaceICategorizationAppSoap
- Parameters:
sessionId
- User session id.- Returns:
- List of projects that are in the category
- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
-