Class TrackerAppSoapStub
java.lang.Object
com.collabnet.ce.soap60.webservices.ClientSoapStub
com.collabnet.ce.soap60.webservices.tracker.TrackerAppSoapStub
- All Implemented Interfaces:
ITrackerAppSoap
-
Field Summary
Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
DEFAULT_CLIENT_TIME_OUT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDateField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String helpText) Adds a custom Date field to a tracker.voidaddMultiSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String[] defaultValues, String helpText) Adds a custom multi select field to a tracker.voidaddSeparator(String sessionId, String trackerId, String separatorType, String separatorLabel) Adds a separator to a tracker.voidaddSingleSelectChildField(String sessionId, String trackerId, String fieldName, String[] fieldValues, String parentFieldId, SoapNamedValues parentChildFieldValueMap, String helpText) Adds a custom single select field to a tracker.voidaddSingleSelectField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String defaultValue, String helpText) Adds a custom single select field to a tracker.voidaddTextField(String sessionId, String trackerId, String fieldName, int displayColumns, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String defaultValue, String helpText, String pattern) Adds a custom text field to a tracker.voidaddUserSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] defaultValues, String userFilter, String helpText) Adds a custom User selection field to a tracker.cloneTracker(String sessionId, String srcTrackerId, String destTrackerTitle, String destTrackerDescription) Clone Tracker within the same projectcloneTrackerAcrossProject(String sessionId, String srcTrackerId, String destProjectId, String destTrackerTitle, String destTrackerDescription) Clone Tracker across the projectvoidcopyWorkflowTransitions(String sessionId, String srcTrackerId, String dstTrackerId) Copies workflow transitions between two trackers.createArtifact(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, String assignedUsername, String releaseId, String planningFolderId, SoapFieldValues flexFields, String attachmentFileName, String attachmentMimeType, String attachmentFileId) Creates a new artifact.createArtifact2(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, String assignedUsername, String releaseId, String planningFolderId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments) Creates a new artifact with multiple attachments.createArtifact3(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, boolean autoSummingPoints, String assignedUsername, String releaseId, String planningFolderId, String teamId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments) Creates a new artifact with multiple attachments and flag to enable the autosumming_points.createArtifact4(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, boolean autoSummingPoints, String assignedUsername, String releaseId, String planningFolderId, String teamId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments, String[] tagNames) Creates a new artifact with multiple attachments, flag to enable the autosumming_points and tags.voidcreateArtifactDependency(String sessionId, String originId, String targetId, String desc) Creates an artifact dependency between two artifacts.createTracker(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon) Creates a new tracker with an iconcreateTracker2(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId) Creates a new tracker with an iconcreateTracker3(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId, boolean autosumForeignChildren) Creates a new tracker with autosum foreign children supportvoiddeleteArtifact(String sessionId, String artifactId) Deletes an artifact.voiddeleteField(String sessionId, String objectId, String fieldId) Deletes a custom/flex-field .voiddeleteSeparator(String sessionId, String trackerId, String layoutId) Deletes a separator of a tracker layout.findArtifacts(String sessionId, String queryString, String projectId, boolean searchAttachments) Finds a list of artifacts matching a search string.findArtifacts2(String sessionId, String queryString, String projectId, boolean searchAttachments) Finds a list of artifacts matching a search string.getAllowedWorkflowTransitionList(String sessionId, String trackerId) Gets workflow transitions for the tracker.getAllowedWorkflowTransitionList2(String sessionId, String trackerId) Gets workflow transitions for the tracker.getAllowedWorkflowTransitionList3(String sessionId, String trackerId) Gets workflow transitions for the tracker.getArtifactData(String sessionId, String artifactId) Returns data associated with the specified artifact.getArtifactData2(String sessionId, String artifactId) Returns data associated with the specified artifact.getArtifactData3(String sessionId, String artifactId) Returns data associated with the specified artifact.getArtifactDetailList(String sessionId, String trackerId, String[] selectedColumns, SoapFilter[] filters, SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) Returns a filtered and ordered list of artifacts from the specified tracker.getArtifactDetailList2(String sessionId, String trackerId, String[] selectedColumns, SoapFilter[] filters, SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) Returns a filtered and ordered list of artifacts from the specified tracker.getArtifactList(String sessionId, String containerId, SoapFilter[] filters) Returns a filtered list of artifacts within the specified container (project or tracker).getArtifactList2(String sessionId, String containerId, SoapFilter[] filters) Returns a filtered list of artifacts within the specified container (project or tracker).getChildDependencyList(String sessionId, String artifactId) Gets the dependency list for an artifact where the artifact is the origin artifact.getCrossTrackerArtifactList(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns) Returns a filtered list of artifacts within the specified container (project or tracker).getCrossTrackerArtifactList2(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns) Returns a filtered list of artifacts within the specified container (project or tracker).Returns the custom/flex-fields associated with a specific tracker.getFields2(String sessionId, String trackerId) Returns the custom/flex-fields associated with a specific tracker.getOrderedTrackerFields(String sessionId, String trackerId) Returns all fields and separators in the given tracker with layout information.getParentDependencyList(String sessionId, String artifactId) Gets the dependency list for an artifact where the artifact is the target artifact.getTracker2Data(String sessionId, String trackerId) Returns a data object for a given trackergetTracker2List(String sessionId, String projectId) Returns a list of trackers for a project in the order that they are displayed in the UI.getTracker3Data(String sessionId, String trackerId) Returns a data object for a given trackergetTracker3List(String sessionId, String projectId) Returns a list of trackers for a project in the order that they are displayed in the UI.getTrackerData(String sessionId, String trackerId) Returns a data object for a given trackergetTrackerList(String sessionId, String projectId) Returns a list of trackers for a project in the order that they are displayed in the UI.getUnitsByProject(String sessionId, String projectId) Gets the units for a given project.moveArtifact(String sessionId, String artifactId, String targetFolderId, String newAssignee) Moves an artifact to a specified target folder.moveArtifact2(String sessionId, String artifactId, String targetFolderId, String newAssignee) Moves an artifact to a specified target folder.voidremoveArtifactDependency(String sessionId, String originId, String targetId) Removes an artifact dependency between two artifacts.voidreorderTrackerFields(String sessionId, String trackerId, String[] layoutIds) Sets a new order of the fields and the separators within a tracker.voidreorderTrackers(String sessionId, String[] trackerIds) Sets a new order of the trackers within a project.voidsetArtifactData(String sessionId, ArtifactSoapDO artifactData, String comment, String attachmentFileName, String attachmentMimeType, String attachmentFileId) Sets data associated with the specified artifact.voidsetArtifactData2(String sessionId, ArtifactSoapDO artifactData, String comment, AttachmentSoapDO[] attachments) Sets data associated along with multiple attachments with the specified artifact.voidsetArtifactData3(String sessionId, Artifact2SoapDO artifactData, String comment, AttachmentSoapDO[] attachments) Sets data associated along with multiple attachments with the specified artifact.voidsetArtifactData4(String sessionId, Artifact3SoapDO artifactData, String comment, AttachmentSoapDO[] attachments) Sets data associated along with multiple attachments with the specified artifact.voidsetArtifactRank(String sessionId, String planningFolderId, String artfToRankId, String artfBeforeId, String artfAfterId) Sets the rank of an artifact relative to one or more other artifactsvoidsetField(String sessionId, String objectId, TrackerFieldSoapDO fieldData) Sets a custom/flex-field that is associated with a specific foldervoidsetField2(String sessionId, String objectId, TrackerField2SoapDO fieldData) Sets a custom/flex-field that is associated with a specific foldervoidsetTracker2Data(String sessionId, Tracker2SoapDO trackerData) Sets data on a specific trackervoidsetTracker3Data(String sessionId, Tracker3SoapDO trackerData) Sets data on a specific tracker with autosum foreign children supportvoidsetTrackerData(String sessionId, TrackerSoapDO trackerData) Sets data on a specific trackerMethods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam
-
Constructor Details
-
TrackerAppSoapStub
-
-
Method Details
-
getTrackerList
Description copied from interface:ITrackerAppSoapReturns a list of trackers for a project in the order that they are displayed in the UI.- Specified by:
getTrackerListin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.projectId- Project id.- Returns:
- List of trackers within the project.
- Throws:
RemoteException
-
getTracker2List
Description copied from interface:ITrackerAppSoapReturns a list of trackers for a project in the order that they are displayed in the UI.- Specified by:
getTracker2Listin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.projectId- Project id.- Returns:
- List of trackers within the project.
- Throws:
RemoteException
-
getTracker3List
Description copied from interface:ITrackerAppSoapReturns a list of trackers for a project in the order that they are displayed in the UI.- Specified by:
getTracker3Listin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.projectId- Project id.- Returns:
- List of trackers within the project.
- Throws:
RemoteException
-
getTrackerData
Description copied from interface:ITrackerAppSoapReturns a data object for a given tracker- Specified by:
getTrackerDatain interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.- Returns:
- Detailed data on the tracker.
- Throws:
RemoteException
-
getTracker2Data
Description copied from interface:ITrackerAppSoapReturns a data object for a given tracker- Specified by:
getTracker2Datain interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.- Returns:
- Detailed data on the tracker.
- Throws:
RemoteException
-
getTracker3Data
Description copied from interface:ITrackerAppSoapReturns a data object for a given tracker- Specified by:
getTracker3Datain interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.- Returns:
- Detailed data on the tracker.
- Throws:
RemoteException
-
setTrackerData
Description copied from interface:ITrackerAppSoapSets data on a specific tracker- Specified by:
setTrackerDatain interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerData- Detailed data on the tracker to set.- Throws:
RemoteException
-
setTracker2Data
Description copied from interface:ITrackerAppSoapSets data on a specific tracker- Specified by:
setTracker2Datain interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerData- Detailed data on the tracker to set.- Throws:
RemoteException
-
setTracker3Data
Description copied from interface:ITrackerAppSoapSets data on a specific tracker with autosum foreign children support- Specified by:
setTracker3Datain interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerData- Detailed data on the tracker to set.- Throws:
RemoteException
-
createTracker
public TrackerSoapDO createTracker(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon) throws RemoteException Description copied from interface:ITrackerAppSoapCreates a new tracker with an icon- Specified by:
createTrackerin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.projectId- The id of the project under which to create the new trackertrackerName- The name of the new trackertrackerTitle- The title of the new trackertrackerDescription- The description of the new trackericon- The tracker icon (null or something between "icon_01.png" and "icon_99.png")- Returns:
- the tracker soap object
- Throws:
RemoteException
-
createTracker2
public Tracker2SoapDO createTracker2(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId) throws RemoteException Description copied from interface:ITrackerAppSoapCreates a new tracker with an icon- Specified by:
createTracker2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.projectId- The id of the project under which to create the new trackertrackerName- The name of the new trackertrackerTitle- The title of the new trackertrackerDescription- The description of the new trackericon- The tracker icon (null or something between "icon_01.png" and "icon_99.png")trackerUnitId- The tracker unit- Returns:
- the tracker soap object
- Throws:
RemoteException
-
createTracker3
public Tracker3SoapDO createTracker3(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId, boolean autosumForeignChildren) throws RemoteException Description copied from interface:ITrackerAppSoapCreates a new tracker with autosum foreign children support- Specified by:
createTracker3in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.projectId- The id of the project under which to create the new trackertrackerName- The name of the new trackertrackerTitle- The title of the new trackertrackerDescription- The description of the new trackericon- The tracker icon (null or something between "icon_01.png" and "icon_99.png")trackerUnitId- The tracker unitautosumForeignChildren- The flag indicating whether the autosum calculation of effort and points includes children from foreign projects- Returns:
- the tracker soap object
- Throws:
RemoteException
-
setField
public void setField(String sessionId, String objectId, TrackerFieldSoapDO fieldData) throws RemoteException Description copied from interface:ITrackerAppSoapSets a custom/flex-field that is associated with a specific folder- Specified by:
setFieldin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.objectId- Object (e.g. tracker) for which to set the field information.fieldData- the custom/flex-field to associate with a specific folder- Throws:
RemoteException- See Also:
-
setField2
public void setField2(String sessionId, String objectId, TrackerField2SoapDO fieldData) throws RemoteException Description copied from interface:ITrackerAppSoapSets a custom/flex-field that is associated with a specific folder- Specified by:
setField2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.objectId- Object (e.g. tracker) for which to set the field information.fieldData- the custom/flex-field to associate with a specific folder- Throws:
RemoteException- See Also:
-
addTextField
public void addTextField(String sessionId, String trackerId, String fieldName, int displayColumns, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String defaultValue, String helpText, String pattern) throws RemoteException Description copied from interface:ITrackerAppSoapAdds a custom text field to a tracker.- Specified by:
addTextFieldin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker to add the field to.fieldName- the name of the fielddisplayColumns- the width of the display areadisplayLines- the height of the display areaisRequired- if the field is requiredisDisabled- if the field is disabledisHiddenOnCreate- if the field is hidden when first createddefaultValue- default valuehelpText- The help text for the fieldpattern- The field validation pattern- Throws:
RemoteException
-
addSingleSelectChildField
public void addSingleSelectChildField(String sessionId, String trackerId, String fieldName, String[] fieldValues, String parentFieldId, SoapNamedValues parentChildFieldValueMap, String helpText) throws RemoteException Description copied from interface:ITrackerAppSoapAdds a custom single select field to a tracker.- Specified by:
addSingleSelectChildFieldin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker to add the field to.fieldName- the name of the fieldfieldValues- Array of valid field valuesparentFieldId- The id of the parent fieldparentChildFieldValueMap- soapNamedValues which keeps mapping between parent field values and child valueshelpText- the help text for the field- Throws:
RemoteException
-
addSingleSelectField
public void addSingleSelectField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String defaultValue, String helpText) throws RemoteException Description copied from interface:ITrackerAppSoapAdds a custom single select field to a tracker.- Specified by:
addSingleSelectFieldin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker to add the field to.fieldName- the name of the fieldisRequired- if the field is requiredisDisabled- if the field is disabledisHiddenOnCreate- if the field is hidden when first createdfieldValues- Array of valid field valuesdefaultValue- default valuehelpText- the help text for the field- Throws:
RemoteException
-
addMultiSelectField
public void addMultiSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String[] defaultValues, String helpText) throws RemoteException Description copied from interface:ITrackerAppSoapAdds a custom multi select field to a tracker.- Specified by:
addMultiSelectFieldin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker to add the field to.fieldName- the name of the fielddisplayLines- the height of the display areaisRequired- if the field is requiredisDisabled- if the field is disabledisHiddenOnCreate- if the field is hidden when first createdfieldValues- possible valuesdefaultValues- default valueshelpText- the help text for the field- Throws:
RemoteException
-
addUserSelectField
public void addUserSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] defaultValues, String userFilter, String helpText) throws RemoteException Description copied from interface:ITrackerAppSoapAdds a custom User selection field to a tracker.- Specified by:
addUserSelectFieldin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker to add the field to.fieldName- the name of the fielddisplayLines- the height of the display areaisRequired- if the field is requiredisDisabled- if the field is disabledisHiddenOnCreate- if the field is hidden when first createddefaultValues- default values for this field. Must be valid usernamesuserFilter- is the filterhelpText- The help text of the field- Throws:
RemoteException- See Also:
-
addDateField
public void addDateField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String helpText) throws RemoteException Description copied from interface:ITrackerAppSoapAdds a custom Date field to a tracker.- Specified by:
addDateFieldin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker to add the field to.fieldName- the name of the fieldisRequired- if the field is requiredisDisabled- if the field is disabledisHiddenOnCreate- if the field is hidden when first createdhelpText- the help text of the field- Throws:
RemoteException
-
deleteField
Description copied from interface:ITrackerAppSoapDeletes a custom/flex-field .- Specified by:
deleteFieldin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.objectId- Object (e.g. tracker).fieldId- the id of the field to delete- Throws:
RemoteException
-
getFields
Description copied from interface:ITrackerAppSoapReturns the custom/flex-fields associated with a specific tracker.- Specified by:
getFieldsin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker for which to return field information.- Returns:
- Array of all field values.
- Throws:
RemoteException
-
getFields2
Description copied from interface:ITrackerAppSoapReturns the custom/flex-fields associated with a specific tracker.- Specified by:
getFields2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker for which to return field information.- Returns:
- Array of all field values.
- Throws:
RemoteException
-
addSeparator
public void addSeparator(String sessionId, String trackerId, String separatorType, String separatorLabel) throws RemoteException Description copied from interface:ITrackerAppSoapAdds a separator to a tracker.- Specified by:
addSeparatorin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker to add the separator to.separatorType- the type of the separatorseparatorLabel- the label of the separator- Throws:
RemoteException
-
deleteSeparator
public void deleteSeparator(String sessionId, String trackerId, String layoutId) throws RemoteException Description copied from interface:ITrackerAppSoapDeletes a separator of a tracker layout.- Specified by:
deleteSeparatorin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker to delete the separator from.layoutId- the layout id of the separator. To get the layout id, use getOrderedTrackerFields.- Throws:
RemoteException
-
getOrderedTrackerFields
public OrderedTrackerFieldSoapList getOrderedTrackerFields(String sessionId, String trackerId) throws RemoteException Description copied from interface:ITrackerAppSoapReturns all fields and separators in the given tracker with layout information.- Specified by:
getOrderedTrackerFieldsin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- The tracker for which to return field information.- Returns:
- Array of all fields and separators.
- Throws:
RemoteException
-
reorderTrackerFields
public void reorderTrackerFields(String sessionId, String trackerId, String[] layoutIds) throws RemoteException Description copied from interface:ITrackerAppSoapSets a new order of the fields and the separators within a tracker.- Specified by:
reorderTrackerFieldsin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Id of tracker which all the fields and the separators belong to.layoutIds- An array of layout ids which can be obtained by getOrderedTrackerFields().- Throws:
RemoteException
-
getArtifactList
public ArtifactSoapList getArtifactList(String sessionId, String containerId, SoapFilter[] filters) throws RemoteException Description copied from interface:ITrackerAppSoapReturns a filtered list of artifacts within the specified container (project or tracker).- Specified by:
getArtifactListin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.containerId- ID of a project or a tracker.filters- Array of filters to apply (null to return unfiltered list).- Returns:
- List of filtered artifacts.
- Throws:
RemoteException
-
getArtifactList2
public Artifact2SoapList getArtifactList2(String sessionId, String containerId, SoapFilter[] filters) throws RemoteException Description copied from interface:ITrackerAppSoapReturns a filtered list of artifacts within the specified container (project or tracker).- Specified by:
getArtifactList2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.containerId- ID of a project or a tracker.filters- Array of filters to apply (null to return unfiltered list).- Returns:
- List of filtered artifacts.
- Throws:
RemoteException
-
getCrossTrackerArtifactList
public ArtifactDetailSoapList getCrossTrackerArtifactList(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns) throws RemoteException Description copied from interface:ITrackerAppSoapReturns a filtered list of artifacts within the specified container (project or tracker).- Specified by:
getCrossTrackerArtifactListin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.containerId- ID of a project or a tracker. (should not be null)filters- Array of filters to apply (null to return unfiltered list).selectedColumns- String array of column names to be selected (null to return all columns).- Returns:
- List of filtered artifacts.
- Throws:
RemoteException
-
getCrossTrackerArtifactList2
public ArtifactDetail2SoapList getCrossTrackerArtifactList2(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns) throws RemoteException Description copied from interface:ITrackerAppSoapReturns a filtered list of artifacts within the specified container (project or tracker).- Specified by:
getCrossTrackerArtifactList2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.containerId- ID of a project or a tracker. (should not be null)filters- Array of filters to apply (null to return unfiltered list).selectedColumns- String array of column names to be selected (null to return all columns).- Returns:
- List of filtered artifacts.
- Throws:
RemoteException
-
getArtifactDetailList
public ArtifactDetailSoapList getArtifactDetailList(String sessionId, String trackerId, String[] selectedColumns, SoapFilter[] filters, SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) throws RemoteException Description copied from interface:ITrackerAppSoapReturns a filtered and ordered list of artifacts from the specified tracker.- Specified by:
getArtifactDetailListin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.selectedColumns- String array of column names to be selected (null to return all columns).filters- Array of filters to apply (null to return unfiltered list).sortKeys- Array ofSortKeyto applystartIndex- The index from which to return the results.maxRows- The max quantity of elements to be returned (-1 will return the full list).exceptionIfExpiredCache- Causes the method to throw an exception if it doesn't have the result in the cacheforceNewQuery- force the re-execution of the query, ignoring any cached copy of the search result.- Returns:
- List of filtered artifacts.
- Throws:
RemoteException
-
getArtifactDetailList2
public ArtifactDetail2SoapList getArtifactDetailList2(String sessionId, String trackerId, String[] selectedColumns, SoapFilter[] filters, SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) throws RemoteException Description copied from interface:ITrackerAppSoapReturns a filtered and ordered list of artifacts from the specified tracker.- Specified by:
getArtifactDetailList2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.See ArtifactSoapDO for filters names constant values
sortKeys- Array ofSortKeyto apply (null to return a default order list that is by ID).startIndex- The index from which to return the results.maxRows- The max quantity of elements to be returned (-1 will return the full list).exceptionIfExpiredCache- Causes the method to throw exception if it doesn't have the results in the cacheforceNewQuery- force the re-execution of the query, ignoring any cached copy of the search result.- Returns:
- List of filtered artifacts.
- Throws:
RemoteException
-
findArtifacts
public ArtifactSoapList findArtifacts(String sessionId, String queryString, String projectId, boolean searchAttachments) throws RemoteException Description copied from interface:ITrackerAppSoapFinds a list of artifacts matching a search string.- Specified by:
findArtifactsin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.queryString- Query string.projectId- The project in which to find artifacts. (if null, search all projects)searchAttachments- Whether to search attachments.- Returns:
- List of artifacts matching search criteria.
- Throws:
RemoteException
-
findArtifacts2
public Artifact2SoapList findArtifacts2(String sessionId, String queryString, String projectId, boolean searchAttachments) throws RemoteException Description copied from interface:ITrackerAppSoapFinds a list of artifacts matching a search string.- Specified by:
findArtifacts2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.queryString- Query string.projectId- The project in which to find artifacts. (if null, search all projects)searchAttachments- Whether to search attachments.- Returns:
- List of artifacts matching search criteria.
- Throws:
RemoteException
-
getArtifactData
Description copied from interface:ITrackerAppSoapReturns data associated with the specified artifact.- Specified by:
getArtifactDatain interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactId- Artifact id.- Returns:
- the data associated with the artifact at the given path
- Throws:
RemoteException
-
getArtifactData2
Description copied from interface:ITrackerAppSoapReturns data associated with the specified artifact.- Specified by:
getArtifactData2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactId- Artifact id.- Returns:
- the data associated with the artifact at the given path
- Throws:
RemoteException
-
getArtifactData3
Description copied from interface:ITrackerAppSoapReturns data associated with the specified artifact.- Specified by:
getArtifactData3in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactId- Artifact id.- Returns:
- the data associated with the artifact at the given path
- Throws:
RemoteException
-
setArtifactData
public void setArtifactData(String sessionId, ArtifactSoapDO artifactData, String comment, String attachmentFileName, String attachmentMimeType, String attachmentFileId) throws RemoteException Description copied from interface:ITrackerAppSoapSets data associated with the specified artifact.- Specified by:
setArtifactDatain interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactData- the data associated with the artifact at the given pathcomment- Comment associated with the change.attachmentFileName- Name of the attached file (or null)attachmentMimeType- Mime type of the attached file (or null)attachmentFileId- ID of the attached file (previously uploaded via *FileStorage service) or null- Throws:
RemoteException
-
setArtifactData2
public void setArtifactData2(String sessionId, ArtifactSoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws RemoteException Description copied from interface:ITrackerAppSoapSets data associated along with multiple attachments with the specified artifact.- Specified by:
setArtifactData2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactData- the data associated with the artifact at the given pathcomment- Comment associated with the change.attachments- attached file List- Throws:
RemoteException
-
setArtifactData3
public void setArtifactData3(String sessionId, Artifact2SoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws RemoteException Description copied from interface:ITrackerAppSoapSets data associated along with multiple attachments with the specified artifact.- Specified by:
setArtifactData3in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactData- the data associated with the artifact at the given pathcomment- Comment associated with the change.attachments- attached file List- Throws:
RemoteException
-
setArtifactData4
public void setArtifactData4(String sessionId, Artifact3SoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws RemoteException Description copied from interface:ITrackerAppSoapSets data associated along with multiple attachments with the specified artifact.- Specified by:
setArtifactData4in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactData- the data associated with the artifact at the given pathcomment- Comment associated with the change.attachments- attached file List- Throws:
RemoteException
-
createArtifact
public ArtifactSoapDO createArtifact(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, String assignedUsername, String releaseId, String planningFolderId, SoapFieldValues flexFields, String attachmentFileName, String attachmentMimeType, String attachmentFileId) throws RemoteException Description copied from interface:ITrackerAppSoapCreates a new artifact.- Specified by:
createArtifactin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.title- Artifact title.description- Artifact description.group- Artifact group.category- Artifact category.status- Artifact status.customer- Customer.priority- Artifact priority.estimatedEffort- Estimated effort to close artifact.remainingEffort- Remaining effort to close artifact.autosumming- Determines whether autosumming should be enabled for the newly created artifact.points- The story points for this artifact.assignedUsername- User this artifact should be assigned to.releaseId- Release this artifact is assigned with.planningFolderId- planning folder, this artifact belongs toflexFields- Flex field values.attachmentFileName- Name of the attached file (or null)attachmentMimeType- Mime type of the attached file (or null)attachmentFileId- ID of the attached file (previously uploaded via *FileStorage service) or null- Returns:
- Newly created artifact object.
- Throws:
RemoteException
-
createArtifact2
public ArtifactSoapDO createArtifact2(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, String assignedUsername, String releaseId, String planningFolderId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments) throws RemoteException Description copied from interface:ITrackerAppSoapCreates a new artifact with multiple attachments.- Specified by:
createArtifact2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.title- Artifact title.description- Artifact description.group- Artifact group.category- Artifact category.status- Artifact status.customer- Customer.priority- Artifact priority.estimatedEffort- Estimated effort to close artifact.remainingEffort- Remaining effort to close artifact.autosumming- Determines whether autosumming should be enabled for the newly created artifact.points- The story points for this artifact.assignedUsername- User this artifact should be assigned to.releaseId- Release this artifact is assigned with.planningFolderId- planning folder, this artifact belongs toflexFields- Flex field values.attachments- attached file List (or null)- Returns:
- Newly created artifact object.
- Throws:
RemoteException
-
createArtifact3
public Artifact2SoapDO createArtifact3(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, boolean autoSummingPoints, String assignedUsername, String releaseId, String planningFolderId, String teamId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments) throws RemoteException Description copied from interface:ITrackerAppSoapCreates a new artifact with multiple attachments and flag to enable the autosumming_points.- Specified by:
createArtifact3in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.title- Artifact title.description- Artifact description.group- Artifact group.category- Artifact category.status- Artifact status.customer- Customer.priority- Artifact priority.estimatedEffort- Estimated effort to close artifact. This will be ignored if autosumming is set to true.remainingEffort- Remaining effort to close artifact. This will be ignored if autosumming is set to true.autosumming- Determines whether autosumming should be enabled for the newly created artifact.points- The story points for this artifact. This will be ignored if autoSummingPoints is set to true.autoSummingPoints- Determines whether autoSummingPoints should be enabled for the newly created artifact.assignedUsername- User this artifact should be assigned to.releaseId- Release this artifact is assigned with.planningFolderId- planning folder, this artifact belongs toteamId- team, this artifact belongs toflexFields- Flex field values.attachments- attached file List (or null)- Returns:
- Newly created artifact object.
- Throws:
RemoteException
-
createArtifact4
public Artifact3SoapDO createArtifact4(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, boolean autoSummingPoints, String assignedUsername, String releaseId, String planningFolderId, String teamId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments, String[] tagNames) throws RemoteException Description copied from interface:ITrackerAppSoapCreates a new artifact with multiple attachments, flag to enable the autosumming_points and tags.- Specified by:
createArtifact4in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.title- Artifact title.description- Artifact description.group- Artifact group.category- Artifact category.status- Artifact status.customer- Customer.priority- Artifact priority.estimatedEffort- Estimated effort to close artifact. This will be ignored if autosumming is set to true.remainingEffort- Remaining effort to close artifact. This will be ignored if autosumming is set to true.autosumming- Determines whether autosumming should be enabled for the newly created artifact.points- The story points for this artifact. This will be ignored if autoSummingPoints is set to true.autoSummingPoints- Determines whether autoSummingPoints should be enabled for the newly created artifact.assignedUsername- User this artifact should be assigned to.releaseId- Release this artifact is assigned with.planningFolderId- planning folder, this artifact belongs toteamId- team, this artifact belongs toflexFields- Flex field values.attachments- attached file List (or null)tagNames- tag names- Returns:
- Newly created artifact object.
- Throws:
RemoteException
-
moveArtifact
public ArtifactSoapDO moveArtifact(String sessionId, String artifactId, String targetFolderId, String newAssignee) throws RemoteException Description copied from interface:ITrackerAppSoapMoves an artifact to a specified target folder.- Specified by:
moveArtifactin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactId- ID of artifact to move.targetFolderId- Target folder ID.newAssignee- The username to assign the newly moved artifact to.- Returns:
- New artifact data object
- Throws:
RemoteException
-
moveArtifact2
public Artifact2SoapDO moveArtifact2(String sessionId, String artifactId, String targetFolderId, String newAssignee) throws RemoteException Description copied from interface:ITrackerAppSoapMoves an artifact to a specified target folder.- Specified by:
moveArtifact2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactId- ID of artifact to move.targetFolderId- Target folder ID.newAssignee- The username to assign the newly moved artifact to.- Returns:
- New artifact data object
- Throws:
RemoteException
-
deleteArtifact
Description copied from interface:ITrackerAppSoapDeletes an artifact.- Specified by:
deleteArtifactin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactId- Artifact id.- Throws:
RemoteException
-
getAllowedWorkflowTransitionList
public WorkflowTransitionSoapList getAllowedWorkflowTransitionList(String sessionId, String trackerId) throws RemoteException Description copied from interface:ITrackerAppSoapGets workflow transitions for the tracker.- Specified by:
getAllowedWorkflowTransitionListin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.- Returns:
- Workflow definitions list.
- Throws:
RemoteException
-
getAllowedWorkflowTransitionList2
public WorkflowTransition2SoapList getAllowedWorkflowTransitionList2(String sessionId, String trackerId) throws RemoteException Description copied from interface:ITrackerAppSoapGets workflow transitions for the tracker.- Specified by:
getAllowedWorkflowTransitionList2in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.- Returns:
- Workflow definitions list.
- Throws:
RemoteException
-
copyWorkflowTransitions
public void copyWorkflowTransitions(String sessionId, String srcTrackerId, String dstTrackerId) throws RemoteException Description copied from interface:ITrackerAppSoapCopies workflow transitions between two trackers.- Specified by:
copyWorkflowTransitionsin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.srcTrackerId- Tracker id.dstTrackerId- Tracker id.- Throws:
RemoteException
-
cloneTracker
public Tracker2SoapDO cloneTracker(String sessionId, String srcTrackerId, String destTrackerTitle, String destTrackerDescription) throws RemoteException Description copied from interface:ITrackerAppSoapClone Tracker within the same project- Specified by:
cloneTrackerin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.srcTrackerId- Tracker id.destTrackerTitle- destination Tracker tiledestTrackerDescription- destination Tracker description- Returns:
- returns cloned Tracker
- Throws:
RemoteException
-
cloneTrackerAcrossProject
public Tracker2SoapDO cloneTrackerAcrossProject(String sessionId, String srcTrackerId, String destProjectId, String destTrackerTitle, String destTrackerDescription) throws RemoteException Description copied from interface:ITrackerAppSoapClone Tracker across the project- Specified by:
cloneTrackerAcrossProjectin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.srcTrackerId- Tracker id.destProjectId- on which project you need to create a trackerdestTrackerTitle- destination tracker titledestTrackerDescription- destination tracker description- Returns:
- returns cloned tracker
- Throws:
RemoteException
-
createArtifactDependency
public void createArtifactDependency(String sessionId, String originId, String targetId, String desc) throws RemoteException Description copied from interface:ITrackerAppSoapCreates an artifact dependency between two artifacts.- Specified by:
createArtifactDependencyin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.originId- Origin artifact id.targetId- Target artifact id.desc- Description for the dependency.- Throws:
RemoteException
-
removeArtifactDependency
public void removeArtifactDependency(String sessionId, String originId, String targetId) throws RemoteException Description copied from interface:ITrackerAppSoapRemoves an artifact dependency between two artifacts.- Specified by:
removeArtifactDependencyin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.originId- Origin artifact id.targetId- Target artifact id.- Throws:
RemoteException
-
setArtifactRank
public void setArtifactRank(String sessionId, String planningFolderId, String artfToRankId, String artfBeforeId, String artfAfterId) throws RemoteException Description copied from interface:ITrackerAppSoapSets the rank of an artifact relative to one or more other artifacts- Specified by:
setArtifactRankin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.planningFolderId- the id of the planning folder in which we are doing the rankartfToRankId- the artifact to rankartfBeforeId- the artifact that should be before itartfAfterId- the artifact that should be after it- Throws:
RemoteException
-
getChildDependencyList
public ArtifactDependencySoapList getChildDependencyList(String sessionId, String artifactId) throws RemoteException Description copied from interface:ITrackerAppSoapGets the dependency list for an artifact where the artifact is the origin artifact.- Specified by:
getChildDependencyListin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactId- Artifact id.- Returns:
- dependency list
- Throws:
RemoteException
-
getParentDependencyList
public ArtifactDependencySoapList getParentDependencyList(String sessionId, String artifactId) throws RemoteException Description copied from interface:ITrackerAppSoapGets the dependency list for an artifact where the artifact is the target artifact.- Specified by:
getParentDependencyListin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.artifactId- Artifact id.- Returns:
- dependency list
- Throws:
RemoteException
-
reorderTrackers
Description copied from interface:ITrackerAppSoapSets a new order of the trackers within a project.- Specified by:
reorderTrackersin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerIds- An array of the tracker ids in their new order.- Throws:
RemoteException
-
getUnitsByProject
public TrackerUnitSoapList getUnitsByProject(String sessionId, String projectId) throws RemoteException Description copied from interface:ITrackerAppSoapGets the units for a given project.- Specified by:
getUnitsByProjectin interfaceITrackerAppSoap- Parameters:
sessionId- User session id.projectId- The id of the project to retrieve the units- Throws:
RemoteException
-
getAllowedWorkflowTransitionList3
public WorkflowTransition3SoapList getAllowedWorkflowTransitionList3(String sessionId, String trackerId) throws RemoteException Description copied from interface:ITrackerAppSoapGets workflow transitions for the tracker.- Specified by:
getAllowedWorkflowTransitionList3in interfaceITrackerAppSoap- Parameters:
sessionId- User session id.trackerId- Tracker id.- Returns:
- Workflow definitions list.
- Throws:
RemoteException
-