com.vasoftware.sf.soap44.webservices.categorization
Interface ICategorizationAppSoap

public interface ICategorizationAppSoap

Provides SOAP services for managing project categories.

Change History

Version 4.4: No changes.

Since:

4.3-SP1

Method Summary

void	addProjectToCategory(java.lang.String sessionId, java.lang.String projectId, java.lang.String categoryId) Add a given project to a category.
CategorySoapDO	createCategory(java.lang.String sessionId, java.lang.String parentId, java.lang.String title, java.lang.String description) Create a category
void	deleteCategory(java.lang.String sessionId, java.lang.String categoryId) Deletes an category.
CategorySoapList	getAllCategories(java.lang.String sessionId) Returns a list of all categories.
CategorySoapDO	getCategoryData(java.lang.String sessionId, java.lang.String categoryId) Returns a data object for a given category
ProjectSoapList	getCategoryProjects(java.lang.String sessionId, java.lang.String categoryId, boolean includeSubcategories) Get list of projects in the specified category and, if requested, subcategories
CategorySoapList	getProjectCategories(java.lang.String sessionId, java.lang.String projectId) Returns a list of categories the project belongs to
CategorySoapDO	getRootCategoryData(java.lang.String sessionId) Returns a data object for the root category
CategorySoapList	getSubcategories(java.lang.String sessionId, java.lang.String categoryId, boolean recursive) Returns a list of subcategories to the specified category.
ProjectSoapList	getUncategorizedProjects(java.lang.String sessionId) Get list of projects that have not been categorized
boolean	isCategorizationEnabled(java.lang.String sessionId) Check if categorization support is enabled site-wide.
void	moveCategory(java.lang.String sessionId, java.lang.String categoryId, java.lang.String dstCategoryId) Move a Category including all subcategories under different parent.
void	removeProjectFromCategory(java.lang.String sessionId, java.lang.String projectId, java.lang.String categoryId) Remove a given project from a category.
void	setCategoryData(java.lang.String sessionId, CategorySoapDO categoryData) Sets data on a specific category

Method Detail

isCategorizationEnabled

boolean isCategorizationEnabled(java.lang.String sessionId)
                                throws java.rmi.RemoteException

Check if categorization support is enabled site-wide.

Parameters:

sessionId - User session id.

Returns:

true/false

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-SP1

createCategory

CategorySoapDO createCategory(java.lang.String sessionId,
                              java.lang.String parentId,
                              java.lang.String title,
                              java.lang.String description)
                              throws java.rmi.RemoteException

Create a category

Parameters:

parentId - ID of the parent category

title - Title of the category

description - Description

Returns:

A category data object representing the newly created category

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - if an existing category already exists

java.rmi.RemoteException

getCategoryData

CategorySoapDO getCategoryData(java.lang.String sessionId,
                               java.lang.String categoryId)
                               throws java.rmi.RemoteException

Returns a data object for a given category

Parameters:

sessionId - User session id.

categoryId - Category id.

Returns:

Detailed data on the category.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"

getRootCategoryData

CategorySoapDO getRootCategoryData(java.lang.String sessionId)
                                   throws java.rmi.RemoteException

Returns a data object for the root category

Parameters:

sessionId - User session id.

Returns:

Detailed data on the root category.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"

setCategoryData

void setCategoryData(java.lang.String sessionId,
                     CategorySoapDO categoryData)
                     throws java.rmi.RemoteException

Sets data on a specific category

Parameters:

sessionId - User session id.

categoryData - Detailed data on the category to set.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when invalid data is specified.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - when the object version mismatches the application server.

java.rmi.RemoteException

Since:

"4.3-SP1"

deleteCategory

void deleteCategory(java.lang.String sessionId,
                    java.lang.String categoryId)
                    throws java.rmi.RemoteException

Deletes an category.

Parameters:

sessionId - User session id.

categoryId - Category id.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"

getAllCategories

CategorySoapList getAllCategories(java.lang.String sessionId)
                                  throws java.rmi.RemoteException

Returns a list of all categories.

Parameters:

sessionId - User session id.

Returns:

List of categories within the project.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"

getSubcategories

CategorySoapList getSubcategories(java.lang.String sessionId,
                                  java.lang.String categoryId,
                                  boolean recursive)
                                  throws java.rmi.RemoteException

Returns a list of subcategories to the specified category.

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:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"

moveCategory

void moveCategory(java.lang.String sessionId,
                  java.lang.String categoryId,
                  java.lang.String dstCategoryId)
                  throws java.rmi.RemoteException

Move a Category including all subcategories under different parent. Fails completely if not everything can be moved.

Parameters:

sessionId - User session id.

categoryId - Category to move

dstCategoryId - Destination parent category

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"

addProjectToCategory

void addProjectToCategory(java.lang.String sessionId,
                          java.lang.String projectId,
                          java.lang.String categoryId)
                          throws java.rmi.RemoteException

Add a given project to a category.

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:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"

removeProjectFromCategory

void removeProjectFromCategory(java.lang.String sessionId,
                               java.lang.String projectId,
                               java.lang.String categoryId)
                               throws java.rmi.RemoteException

Remove a given project from a category.

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:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"

getProjectCategories

CategorySoapList getProjectCategories(java.lang.String sessionId,
                                      java.lang.String projectId)
                                      throws java.rmi.RemoteException

Returns a list of categories the project belongs to

Parameters:

sessionId - User session id.

projectId - ID of the project

Returns:

List of categories the project is in

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"

getCategoryProjects

ProjectSoapList getCategoryProjects(java.lang.String sessionId,
                                    java.lang.String categoryId,
                                    boolean includeSubcategories)
                                    throws java.rmi.RemoteException

Get list of projects in the specified category and, if requested, subcategories

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:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"

getUncategorizedProjects

ProjectSoapList getUncategorizedProjects(java.lang.String sessionId)
                                         throws java.rmi.RemoteException

Get list of projects that have not been categorized

Parameters:

sessionId - User session id.

Returns:

List of projects that are in the category

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.3-SP1"