com.collabnet.ce.webservices
Class TrackerApp

java.lang.Object
  extended by com.collabnet.ce.webservices.AbstractSoapApp
      extended by com.collabnet.ce.webservices.TrackerApp

public class TrackerApp
extends AbstractSoapApp

Class to hold the tracker-related methods. Wraps a collabNetApp.


Constructor Summary
TrackerApp(CollabNetApp collabNetApp)
          Contructs a new TrackerApp.
 
Method Summary
 com.collabnet.ce.soap50.webservices.tracker.ArtifactSoapDO createNewTrackerArtifact(java.lang.String trackerId, java.lang.String title, java.lang.String description, java.lang.String group, java.lang.String category, java.lang.String status, java.lang.String customer, int priority, int estimatedHours, java.lang.String assignTo, java.lang.String releaseId, com.collabnet.ce.soap50.types.SoapFieldValues flexFields, java.lang.String fileName, java.lang.String fileMimeType, java.lang.String fileId)
          Create a new tracker artifact with the given values.
 com.collabnet.ce.soap50.webservices.tracker.ArtifactSoapDO findLastTrackerArtifact(java.lang.String trackerId, java.lang.String title)
          Find the most recently submitted TrackerArtifact matching the given title.
 com.collabnet.ce.soap50.webservices.tracker.ArtifactSoapDO getArtifactDO(java.lang.String artifactId)
          Given an artifactId (which you can get from an ArtifactSoapRow) return the appropriate ArtifactSoapDO.
 java.lang.String getTrackerId(java.lang.String projectId, java.lang.String trackerName)
          Find the matching tracker id.
 java.util.Collection<java.lang.String> getTrackers(java.lang.String projectId)
          Return a list of unique tracker titles for a given project.
 void setArtifactData(com.collabnet.ce.soap50.webservices.tracker.ArtifactSoapDO artifact, java.lang.String comment, java.lang.String fileName, java.lang.String fileMimeType, java.lang.String fileId)
          Update an existing artifact.
 
Methods inherited from class com.collabnet.ce.webservices.AbstractSoapApp
checkValidSessionId, getServerUrl, getSessionId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TrackerApp

public TrackerApp(CollabNetApp collabNetApp)
Contructs a new TrackerApp.

Parameters:
collabNetApp - a valid (logged-in) instance.
Method Detail

getTrackerId

public java.lang.String getTrackerId(java.lang.String projectId,
                                     java.lang.String trackerName)
                              throws java.rmi.RemoteException
Find the matching tracker id.

Parameters:
projectId -
trackerName -
Returns:
the tracker id for this name, in this project, if found. Otherwise, null.
Throws:
java.rmi.RemoteException

getTrackers

public java.util.Collection<java.lang.String> getTrackers(java.lang.String projectId)
                                                   throws java.rmi.RemoteException
Return a list of unique tracker titles for a given project.

Parameters:
projectId -
Returns:
Collection of unique tracker names.
Throws:
java.rmi.RemoteException

findLastTrackerArtifact

public com.collabnet.ce.soap50.webservices.tracker.ArtifactSoapDO findLastTrackerArtifact(java.lang.String trackerId,
                                                                                          java.lang.String title)
                                                                                   throws java.rmi.RemoteException
Find the most recently submitted TrackerArtifact matching the given title.

Parameters:
trackerId -
title - of the tracker to find.
Returns:
artifact for the last artifact with that title.
Throws:
java.rmi.RemoteException

getArtifactDO

public com.collabnet.ce.soap50.webservices.tracker.ArtifactSoapDO getArtifactDO(java.lang.String artifactId)
                                                                         throws java.rmi.RemoteException
Given an artifactId (which you can get from an ArtifactSoapRow) return the appropriate ArtifactSoapDO.

Parameters:
artifactId -
Returns:
artifact data object with the given id.
Throws:
java.rmi.RemoteException

createNewTrackerArtifact

public com.collabnet.ce.soap50.webservices.tracker.ArtifactSoapDO createNewTrackerArtifact(java.lang.String trackerId,
                                                                                           java.lang.String title,
                                                                                           java.lang.String description,
                                                                                           java.lang.String group,
                                                                                           java.lang.String category,
                                                                                           java.lang.String status,
                                                                                           java.lang.String customer,
                                                                                           int priority,
                                                                                           int estimatedHours,
                                                                                           java.lang.String assignTo,
                                                                                           java.lang.String releaseId,
                                                                                           com.collabnet.ce.soap50.types.SoapFieldValues flexFields,
                                                                                           java.lang.String fileName,
                                                                                           java.lang.String fileMimeType,
                                                                                           java.lang.String fileId)
                                                                                    throws java.rmi.RemoteException
Create a new tracker artifact with the given values.

Parameters:
trackerId -
title - for the new tracker
description - of the tracker
group - of the tracker
category - of the tracker
status - of the tracker (open, closed, etc).
customer - this artifact affects.
priority - of the artifact.
estimatedHours - to fix the issue.
assignTo - user to assign this issue to.
releaseId - of the release this issue is associated with.
flexFields - user-defined fields.
fileName - of the attachment.
fileMimeType - of the attachment.
fileId - of the attachment (returned when attachment was uploaded).
Returns:
the newly created ArtifactSoapDO.
Throws:
java.rmi.RemoteException

setArtifactData

public void setArtifactData(com.collabnet.ce.soap50.webservices.tracker.ArtifactSoapDO artifact,
                            java.lang.String comment,
                            java.lang.String fileName,
                            java.lang.String fileMimeType,
                            java.lang.String fileId)
                     throws java.rmi.RemoteException
Update an existing artifact.

Parameters:
artifact - to update
comment - of this update.
fileName - of associated attachment.
fileMimeType - of associated attachment.
fileId - of associated attachment (returned when attachment was uploaded)
Throws:
java.rmi.RemoteException - if the operation fails


Copyright © 2010. All Rights Reserved.