Class TagAppSoapStub
java.lang.Object
com.collabnet.ce.soap60.webservices.ClientSoapStub
com.collabnet.ce.soap60.webservices.tag.TagAppSoapStub
- All Implemented Interfaces:
ITagAppSoap
-
Field Summary
Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
DEFAULT_CLIENT_TIME_OUT
-
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.ClientSoapStub
getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam
-
Constructor Details
-
TagAppSoapStub
-
-
Method Details
-
listTags
Description copied from interface:ITagAppSoap
Gets the list of tags defined for the given project- Specified by:
listTags
in interfaceITagAppSoap
- 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.RemoteException
-
getTag
Description copied from interface:ITagAppSoap
Gets tag data for the specified tag id- Specified by:
getTag
in interfaceITagAppSoap
- 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.RemoteException
-
getTagByName
public TagSoapDO getTagByName(String sessionId, String projectId, String tagName) throws RemoteException Description copied from interface:ITagAppSoap
Gets tag data by name in the specified project- Specified by:
getTagByName
in interfaceITagAppSoap
- 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.RemoteException
-
createTag
public TagSoapDO createTag(String sessionId, String projectId, String name, String description) throws RemoteException Description copied from interface:ITagAppSoap
Creates a tag in the specified project- Specified by:
createTag
in interfaceITagAppSoap
- 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.RemoteException
-
updateTag
public TagSoapDO updateTag(String sessionId, String tagId, String name, String description) throws RemoteException Description copied from interface:ITagAppSoap
Updates a tag's name and description- Specified by:
updateTag
in interfaceITagAppSoap
- 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.RemoteException
-
deleteTag
Description copied from interface:ITagAppSoap
Deletes a tag- Specified by:
deleteTag
in interfaceITagAppSoap
- 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.RemoteException
-
getObjectTags
Description copied from interface:ITagAppSoap
Gets object tags- Specified by:
getObjectTags
in interfaceITagAppSoap
- 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.RemoteException
-
setObjectTags
public TagSoapList setObjectTags(String sessionId, String objectId, String[] tagIds) throws RemoteException Description copied from interface:ITagAppSoap
Sets object tags- Specified by:
setObjectTags
in interfaceITagAppSoap
- 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.RemoteException
-