Class CategorizationAppSoap
java.lang.Object
com.collabnet.ce.soap60.webservices.WebService
com.collabnet.ce.soap60.webservices.categorization.CategorizationAppSoap
- All Implemented Interfaces:
ICategorizationAppSoap
Provides SOAP services for managing project categories.
Change History
Version 4.4: No changes.
- Since:
- 4.3-SP1
-
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.WebService
assertNormalProject, assertProjectGroup, canGiveFullUserDetails, checkGeneralPermission, checkPermission, checkPermission, checkSiteWidePermission, createUserSessionKey, downloadFile, filterInvalidProjMembers, generateFolderName, getAccessControlService, getApplicationRegistryService, getAttachment, getAuthenticationService, getCategorization, getCoreService, getDiscussion, getDocMan, getDocumentRootFolder, getFileStorageService, getFolderKey, getFolderPath, getFolderPath, getFolderPath, getFrs, getIntegrationData, getItemPath, getItemPath, getLocale, getMonitoring, getNews, getNulledMinSoapDate, getObjectKey, getObjectPath, getOperation, getPages, getPlanning, getPluggableComponent, getProjectId, getProjectPath, getProjectPath, getRbac, getSearch, getStoredFileSize, getStoredFileText, getTagService, getTeam, getTemplate, getTracker, getUser, getUserData, getUsername, getUserService, getWiki, hasPermission, hasSiteWidePermission, isFolderResource, isProjectGroup, isProjectId, isStrEmpty, isSuperUser, isValidEmail, makeStoredFileDO, makeStoredFileDOs, requireProjectAdminPermission, setPartialOrFullUserData, setUserNameToResponse, storeFile, storeTextFile, validateChoice, validateChoice, validateIconFile, validateString, validateStringArray, validateStringWithTrim, validateTokenAndExactUsername, validateTokenAndExactUsername, validateWikiPageName, verifyLicense
-
Constructor Details
-
CategorizationAppSoap
public CategorizationAppSoap()
-
-
Method Details
-
isCategorizationEnabled
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.- Since:
- 4.3-SP1
-
createCategory
public CategorySoapDO createCategory(String sessionId, String parentId, String title, String description) throws InvalidSessionFault, PermissionDeniedFault, SystemFault, NoSuchObjectFault, ObjectAlreadyExistsFault 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 exists- Since:
- 4.3-SP1
-
getCategoryData
public CategorySoapDO getCategoryData(String sessionId, String categoryId) throws InvalidSessionFault, NoSuchObjectFault, SystemFault 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.- Since:
- "4.3-SP1"
-
getRootCategoryData
public CategorySoapDO getRootCategoryData(String sessionId) throws InvalidSessionFault, NoSuchObjectFault, SystemFault 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.- Since:
- "4.3-SP1"
-
setCategoryData
public void setCategoryData(String sessionId, CategorySoapDO categoryData) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, IllegalArgumentFault, VersionMismatchFault 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.- Since:
- "4.3-SP1"
-
deleteCategory
public void deleteCategory(String sessionId, String categoryId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault 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.- Since:
- "4.3-SP1"
-
getAllCategories
public CategorySoapList getAllCategories(String sessionId) throws InvalidSessionFault, NoSuchObjectFault, SystemFault 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.- Since:
- "4.3-SP1"
-
getSubcategories
public CategorySoapList getSubcategories(String sessionId, String categoryId, boolean recursive) throws InvalidSessionFault, NoSuchObjectFault, SystemFault 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.- Since:
- "4.3-SP1"
-
moveCategory
public void moveCategory(String sessionId, String categoryId, String dstCategoryId) throws InvalidSessionFault, PermissionDeniedFault, SystemFault 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.- Since:
- "4.3-SP1"
-
addProjectToCategory
public void addProjectToCategory(String sessionId, String projectId, String categoryId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, ObjectAlreadyExistsFault, SystemFault 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.- Since:
- "4.3-SP1"
-
removeProjectFromCategory
public void removeProjectFromCategory(String sessionId, String projectId, String categoryId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault 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.- Since:
- "4.3-SP1"
-
getProjectCategories
public CategorySoapList getProjectCategories(String sessionId, String projectId) throws InvalidSessionFault, PermissionDeniedFault, NoSuchObjectFault, SystemFault 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.- Since:
- "4.3-SP1"
-
getCategoryProjects
public ProjectSoapList getCategoryProjects(String sessionId, String categoryId, boolean includeSubcategories) throws InvalidSessionFault, NoSuchObjectFault, SystemFault 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.- Since:
- "4.3-SP1"
-
getUncategorizedProjects
public ProjectSoapList getUncategorizedProjects(String sessionId) throws InvalidSessionFault, SystemFault 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.- Since:
- "4.3-SP1"
-