public interface ITagAppSoap
Modifier and Type | Method and Description |
---|---|
TagSoapDO |
createTag(String sessionId,
String projectId,
String name,
String description)
Creates a tag in the specified project
|
void |
deleteTag(String sessionId,
String tagId)
Deletes a tag
|
TagSoapList |
getObjectTags(String sessionId,
String objectId)
Gets object tags
|
TagSoapDO |
getTag(String sessionId,
String tagId)
Gets tag data for the specified tag id
|
TagSoapDO |
getTagByName(String sessionId,
String projectId,
String tagName)
Gets tag data by name in the specified project
|
TagSoapList |
listTags(String sessionId,
String projectId)
Gets the list of tags defined for the given project
|
TagSoapDO |
updateTag(String sessionId,
String tagId,
String name,
String description)
Updates a tag's name and description
|
TagSoapList listTags(String sessionId, String projectId) throws RemoteException
sessionId
- User session idprojectId
- Project identifier.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the project id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the current user does not have permission to view tags.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
TagSoapDO getTag(String sessionId, String tagId) throws RemoteException
sessionId
- User session idtagId
- Tag idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when session id is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user does not have permission to view tagscom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when tag id is not validcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level exception occurs.RemoteException
TagSoapDO getTagByName(String sessionId, String projectId, String tagName) throws RemoteException
sessionId
- User session idprojectId
- Project identifiertagName
- Tag namecom.collabnet.ce.soap60.fault.InvalidSessionFault
- when session id is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user does not have permission to view tagscom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when project id/tag name is not validcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level exception occurs.RemoteException
TagSoapDO createTag(String sessionId, String projectId, String name, String description) throws RemoteException
sessionId
- User session idprojectId
- Project identifiername
- tag's namedescription
- tag's descriptioncom.collabnet.ce.soap60.fault.InvalidSessionFault
- when session id is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user does not have permission to create tagscom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when project id is not validcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- when new tag name is not validcom.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- when another tag exists by the new namecom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level exception occurs.RemoteException
TagSoapDO updateTag(String sessionId, String tagId, String name, String description) throws RemoteException
sessionId
- User session idtagId
- Tag idname
- Tag's new namedescription
- Tag's new descriptioncom.collabnet.ce.soap60.fault.InvalidSessionFault
- when session id is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user does not have permission to edit tagscom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when tag id is not validcom.collabnet.ce.soap60.fault.VersionMismatchFault
- when there is a version mismatchcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- when new tag name is not validcom.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- when another tag exists by the new namecom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level exception occurs.RemoteException
void deleteTag(String sessionId, String tagId) throws RemoteException
sessionId
- User session idtagId
- Tag idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when session id is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user does not have permission to delete tagscom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when tag id is not validcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level exception occurs.RemoteException
TagSoapList getObjectTags(String sessionId, String objectId) throws RemoteException
sessionId
- User session idobjectId
- Object id (artifact or document)com.collabnet.ce.soap60.fault.InvalidSessionFault
- when session id is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user does not have permission to view the specified objectcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when object id is not validcom.collabnet.ce.soap60.fault.InvalidOperationFault
- when object id does not represent an artifact or a documentcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level exception occurs.RemoteException
Copyright © 2017 CollabNet. All Rights Reserved.