Interface ICategorizationAppSoap
- All Known Implementing Classes:
CategorizationAppSoap
,CategorizationAppSoapMockStub
,CategorizationAppSoapStub
public interface ICategorizationAppSoap
-
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 category
-
Method Details
-
isCategorizationEnabled
Checks if categorization support is enabled site-wide.- 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
- Since:
- 4.3-SP1
-
createCategory
CategorySoapDO createCategory(String sessionId, String parentId, String title, String description) throws RemoteException Creates a category- 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
- Since:
- 4.3-SP1
-
getCategoryData
Returns a data object for a given category- 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
- Since:
- "4.3-SP1"
-
getRootCategoryData
Returns a data object for the root category- 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
- Since:
- "4.3-SP1"
-
setCategoryData
Sets data on a specific category- 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
- Since:
- "4.3-SP1"
-
deleteCategory
Deletes an category.- 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
- Since:
- "4.3-SP1"
-
getAllCategories
Returns a list of all categories.- 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
- Since:
- "4.3-SP1"
-
getSubcategories
CategorySoapList getSubcategories(String sessionId, String categoryId, boolean recursive) throws RemoteException Returns a list of subcategories to the specified category.- 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
- Since:
- "4.3-SP1"
-
moveCategory
Moves a Category including all subcategories under different parent. Fails completely if not everything can be moved.- 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
- Since:
- "4.3-SP1"
-
addProjectToCategory
void addProjectToCategory(String sessionId, String projectId, String categoryId) throws RemoteException Adds a given project to a category.- 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
- Since:
- "4.3-SP1"
-
removeProjectFromCategory
void removeProjectFromCategory(String sessionId, String projectId, String categoryId) throws RemoteException Removes a given project from a category.- 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
- Since:
- "4.3-SP1"
-
getProjectCategories
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:
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
- Since:
- "4.3-SP1"
-
getCategoryProjects
ProjectSoapList getCategoryProjects(String sessionId, String categoryId, boolean includeSubcategories) throws RemoteException Gets list of projects in the specified category and, if requested, subcategories- 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
- Since:
- "4.3-SP1"
-
getUncategorizedProjects
Gets list of projects that have not been categorized- 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
- Since:
- "4.3-SP1"
-