Class CategorizationAppSoapStub
- java.lang.Object
-
- com.collabnet.ce.soap60.webservices.ClientSoapStub
-
- com.collabnet.ce.soap60.webservices.categorization.CategorizationAppSoapStub
-
- All Implemented Interfaces:
ICategorizationAppSoap
public class CategorizationAppSoapStub extends ClientSoapStub implements ICategorizationAppSoap
-
-
Field Summary
-
Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
DEFAULT_CLIENT_TIME_OUT
-
-
Constructor Summary
Constructors Constructor Description CategorizationAppSoapStub(String soapServerUrl)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddProjectToCategory(String sessionId, String projectId, String categoryId)Adds a given project to a category.CategorySoapDOcreateCategory(String sessionId, String parentId, String title, String description)Creates a categoryvoiddeleteCategory(String sessionId, String categoryId)Deletes an category.CategorySoapListgetAllCategories(String sessionId)Returns a list of all categories.CategorySoapDOgetCategoryData(String sessionId, String categoryId)Returns a data object for a given categoryProjectSoapListgetCategoryProjects(String sessionId, String categoryId, boolean includeSubcategories)Gets list of projects in the specified category and, if requested, subcategoriesCategorySoapListgetProjectCategories(String sessionId, String projectId)Returns a list of categories the project belongs toCategorySoapDOgetRootCategoryData(String sessionId)Returns a data object for the root categoryCategorySoapListgetSubcategories(String sessionId, String categoryId, boolean recursive)Returns a list of subcategories to the specified category.ProjectSoapListgetUncategorizedProjects(String sessionId)Gets list of projects that have not been categorizedbooleanisCategorizationEnabled(String sessionId)Checks if categorization support is enabled site-wide.voidmoveCategory(String sessionId, String categoryId, String dstCategoryId)Moves a Category including all subcategories under different parent.voidremoveProjectFromCategory(String sessionId, String projectId, String categoryId)Removes a given project from a category.voidsetCategoryData(String sessionId, CategorySoapDO categoryData)Sets data on a specific category-
Methods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam
-
-
-
-
Constructor Detail
-
CategorizationAppSoapStub
public CategorizationAppSoapStub(String soapServerUrl)
-
-
Method Detail
-
isCategorizationEnabled
public boolean isCategorizationEnabled(String sessionId) throws RemoteException
Description copied from interface:ICategorizationAppSoapChecks if categorization support is enabled site-wide.- Specified by:
isCategorizationEnabledin 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:ICategorizationAppSoapCreates a category- Specified by:
createCategoryin 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
public CategorySoapDO getCategoryData(String sessionId, String categoryId) throws RemoteException
Description copied from interface:ICategorizationAppSoapReturns a data object for a given category- Specified by:
getCategoryDatain 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
public CategorySoapDO getRootCategoryData(String sessionId) throws RemoteException
Description copied from interface:ICategorizationAppSoapReturns a data object for the root category- Specified by:
getRootCategoryDatain 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
public void setCategoryData(String sessionId, CategorySoapDO categoryData) throws RemoteException
Description copied from interface:ICategorizationAppSoapSets data on a specific category- Specified by:
setCategoryDatain 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
public void deleteCategory(String sessionId, String categoryId) throws RemoteException
Description copied from interface:ICategorizationAppSoapDeletes an category.- Specified by:
deleteCategoryin 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
public CategorySoapList getAllCategories(String sessionId) throws RemoteException
Description copied from interface:ICategorizationAppSoapReturns a list of all categories.- Specified by:
getAllCategoriesin 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:ICategorizationAppSoapReturns a list of subcategories to the specified category.- Specified by:
getSubcategoriesin 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:ICategorizationAppSoapMoves a Category including all subcategories under different parent. Fails completely if not everything can be moved.- Specified by:
moveCategoryin 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:ICategorizationAppSoapAdds a given project to a category.- Specified by:
addProjectToCategoryin 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:ICategorizationAppSoapRemoves a given project from a category.- Specified by:
removeProjectFromCategoryin 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:ICategorizationAppSoapReturns a list of categories the project belongs to- Specified by:
getProjectCategoriesin 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:ICategorizationAppSoapGets list of projects in the specified category and, if requested, subcategories- Specified by:
getCategoryProjectsin 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
public ProjectSoapList getUncategorizedProjects(String sessionId) throws RemoteException
Description copied from interface:ICategorizationAppSoapGets list of projects that have not been categorized- Specified by:
getUncategorizedProjectsin 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
-
-