Package com.collabnet.ce.soap60.webservices.categorization

Class CategorizationAppSoap

java.lang.Object

com.collabnet.ce.soap60.webservices.WebService

com.collabnet.ce.soap60.webservices.categorization.CategorizationAppSoap

All Implemented Interfaces:

ICategorizationAppSoap

public class CategorizationAppSoap
extends WebService
implements ICategorizationAppSoap

Provides SOAP services for managing project categories.

Change History

Version 4.4: No changes.

Since:

4.3-SP1

Constructor Summary

Constructors

Constructor	Description
CategorizationAppSoap()

Method Summary

Modifier and Type	Method	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

Methods 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CategorizationAppSoap

public CategorizationAppSoap()

Method Detail

isCategorizationEnabled

public boolean isCategorizationEnabled(String sessionId)
                                throws InvalidSessionFault,
                                       SystemFault

Checks if categorization support is enabled site-wide.

Specified by:

isCategorizationEnabled in interface ICategorizationAppSoap

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 interface ICategorizationAppSoap

Parameters:

sessionId - User session id.

parentId - ID of the parent category

title - Title of the category

description - 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 interface ICategorizationAppSoap

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 interface ICategorizationAppSoap

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 interface ICategorizationAppSoap

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 interface ICategorizationAppSoap

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 interface ICategorizationAppSoap

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 interface ICategorizationAppSoap

Parameters:

sessionId - User session id.

categoryId - category whose immediate subcategories should be returned

recursive - 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 interface ICategorizationAppSoap

Parameters:

sessionId - User session id.

categoryId - Category to move

dstCategoryId - 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 interface ICategorizationAppSoap

Parameters:

sessionId - User session id.

projectId - ID of the project to add to a category

categoryId - 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 interface ICategorizationAppSoap

Parameters:

sessionId - User session id.

projectId - ID of the project to remove from a category

categoryId - 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 interface ICategorizationAppSoap

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 interface ICategorizationAppSoap

Parameters:

sessionId - User session id.

categoryId - category id

includeSubcategories - 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 interface ICategorizationAppSoap

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"