Class TagAppSoap
java.lang.Object
com.collabnet.ce.soap60.webservices.WebService
com.collabnet.ce.soap60.webservices.tag.TagAppSoap
Provides SOAP services for tag objects
- Since:
- 17.4
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreates a tag in the specified projectvoid
Deletes a taggetObjectTags
(String sessionId, String objectId) Gets object tagsGets tag data for the specified tag idgetTagByName
(String sessionId, String projectId, String tagName) Gets tag data by name in the specified projectGets the list of tags defined for the given projectsetObjectTags
(String sessionId, String objectId, String[] tagIds) Sets object tagsUpdates a tag's name and descriptionMethods 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
-
TagAppSoap
public TagAppSoap()
-
-
Method Details
-
listTags
public TagSoapList listTags(String sessionId, String projectId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault Gets the list of tags defined for the given project- Parameters:
sessionId
- User session idprojectId
- Project identifier.- Returns:
- List of tags.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the project id is invalid.PermissionDeniedFault
- when the current user does not have permission to view tags.SystemFault
- when an unexpected system level error occurs.- Since:
- 17.4
-
getTag
public TagSoapDO getTag(String sessionId, String tagId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault Gets tag data for the specified tag id- Parameters:
sessionId
- User session idtagId
- Tag id- Returns:
- Tag data
- Throws:
InvalidSessionFault
- when session id is not validPermissionDeniedFault
- when current user does not have permission to view tagsNoSuchObjectFault
- when tag id is not validSystemFault
- when an unexpected system level exception occurs.- Since:
- 17.4
-
getTagByName
public TagSoapDO getTagByName(String sessionId, String projectId, String tagName) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault Gets tag data by name in the specified project- Parameters:
sessionId
- User session idprojectId
- Project identifiertagName
- Tag name- Returns:
- Tag data
- Throws:
InvalidSessionFault
- when session id is not validPermissionDeniedFault
- when current user does not have permission to view tagsNoSuchObjectFault
- when project id/tag name is not validSystemFault
- when an unexpected system level exception occurs.- Since:
- 17.4
-
createTag
public TagSoapDO createTag(String sessionId, String projectId, String name, String description) throws InvalidSessionFault, PermissionDeniedFault, NoSuchObjectFault, IllegalArgumentFault, ObjectAlreadyExistsFault, SystemFault Creates a tag in the specified project- Parameters:
sessionId
- User session idprojectId
- Project identifiername
- tag's namedescription
- tag's description- Returns:
- New tag's data
- Throws:
InvalidSessionFault
- when session id is not validPermissionDeniedFault
- when current user does not have permission to create tagsNoSuchObjectFault
- when project id is not validIllegalArgumentFault
- when new tag name is not validObjectAlreadyExistsFault
- when another tag exists by the new nameSystemFault
- when an unexpected system level exception occurs.
-
updateTag
public TagSoapDO updateTag(String sessionId, String tagId, String name, String description) throws InvalidSessionFault, PermissionDeniedFault, NoSuchObjectFault, VersionMismatchFault, IllegalArgumentFault, ObjectAlreadyExistsFault, SystemFault Updates a tag's name and description- Parameters:
sessionId
- User session idtagId
- Tag idname
- Tag's new namedescription
- Tag's new description- Returns:
- Updated tag data
- Throws:
InvalidSessionFault
- when session id is not validPermissionDeniedFault
- when current user does not have permission to edit tagsNoSuchObjectFault
- when tag id is not validVersionMismatchFault
- when there is a version mismatchIllegalArgumentFault
- when new tag name is not validObjectAlreadyExistsFault
- when another tag exists by the new nameSystemFault
- when an unexpected system level exception occurs.
-
deleteTag
public void deleteTag(String sessionId, String tagId) throws InvalidSessionFault, PermissionDeniedFault, NoSuchObjectFault, SystemFault Deletes a tag- Parameters:
sessionId
- User session idtagId
- Tag id- Throws:
InvalidSessionFault
- when session id is not validPermissionDeniedFault
- when current user does not have permission to delete tagsNoSuchObjectFault
- when tag id is not validSystemFault
- when an unexpected system level exception occurs.- Since:
- 17.4
-
getObjectTags
public TagSoapList getObjectTags(String sessionId, String objectId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, InvalidOperationFault, SystemFault Gets object tags- Parameters:
sessionId
- User session idobjectId
- Object id (artifact or document)- Returns:
- List of tags for the object
- Throws:
InvalidSessionFault
- when session id is not validPermissionDeniedFault
- when current user does not have permission to view the specified objectNoSuchObjectFault
- when object id is not validInvalidOperationFault
- when object id does not represent an artifact or a documentSystemFault
- when an unexpected system level exception occurs.
-
setObjectTags
public TagSoapList setObjectTags(String sessionId, String objectId, String[] tagIds) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, InvalidOperationFault, IllegalArgumentFault Sets object tags- Parameters:
sessionId
- User session idobjectId
- Object id (artifact or document)tagIds
- Array of tag ids (null or empty will remove the existing tags)- Returns:
- Updated list of tags for the object
- Throws:
InvalidSessionFault
- when session id is not validPermissionDeniedFault
- when current user does not have permission to edit the specified objectNoSuchObjectFault
- when object/tag id is not validIllegalArgumentFault
- when number of tags exceeds allowed limit (10)InvalidOperationFault
- when object id does not represent an artifact or a documentSystemFault
- when an unexpected system level exception occurs.
-