com.microsoft.tfs.core.clients.versioncontrol.soapextensions
Class Changeset

java.lang.Object
  extended by com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
      extended by com.microsoft.tfs.core.clients.versioncontrol.soapextensions.Changeset

public final class Changeset
extends com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

Represents a set of changes committed to the repository.

Since:
TEE-SDK-10.1

Field Summary
static int MAX
          Value used as the largest possible changeset number in any TFS repository.
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
Changeset(ms.tfs.versioncontrol.clientservices._03._Changeset changeset)
           
Changeset()
           
Changeset(Change[] changes, java.lang.String comment, CheckinNote checkinNote, PolicyOverrideInfo policyOverride, java.lang.String committer, java.lang.String committerDisplayName, java.util.Calendar date, int changeSetID, java.lang.String owner, java.lang.String ownerDisplayName, PropertyValue[] properties)
           
Changeset(Changeset changeset, Change change)
           
Changeset(java.lang.String owner, java.lang.String comment, CheckinNote checkinNote, PolicyOverrideInfo policyOverride)
           
 
Method Summary
 Change[] getChanges()
           
 int getChangesetID()
           
 CheckinNote getCheckinNote()
           
 java.lang.String getComment()
           
 java.lang.String getCommitter()
           
 java.lang.String getCommitterDisplayName()
           
 java.util.Calendar getDate()
           
static java.util.Calendar getDefaultDate()
          Gets a default date for a Changeset's construction, which is the .NET epoch.
 java.lang.String getOwner()
           
 java.lang.String getOwnerDisplayName()
           
 PolicyOverrideInfo getPolicyOverride()
           
 PropertyValue[] getPropertyValues()
           
 ms.tfs.versioncontrol.clientservices._03._Changeset getWebServiceObject()
          Gets the web service object this class wraps.
 WorkItem[] getWorkItems()
          Gets the work items which reference this changeset.
 WorkItem[] getWorkItems(WorkItemClient workItemClient)
          Gets the work items which reference this changeset.
 void setChanges(Change[] changes)
           
 void setChangesetID(int changesetID)
           
 void setCheckinNote(CheckinNote checkinNote)
           
 void setComment(java.lang.String comment)
           
 void setCommitter(java.lang.String committer)
           
 void setCommitterDisplayName(java.lang.String committer)
           
 void setDate(java.util.Calendar date)
           
 void setOwner(java.lang.String owner)
           
 void setOwnerDisplayName(java.lang.String owner)
           
 void setPolicyOverride(PolicyOverrideInfo policyOverride)
           
 void setWorkItems(WorkItem[] workItems)
          Set the work items which reference this changeset.
 void sortChanges()
          Sorts the changes in the changeset.
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
equals, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX

public static final int MAX
Value used as the largest possible changeset number in any TFS repository.

Constant Field Value:
2147483647
See Also:
Constant Field Values
Constructor Detail

Changeset

public Changeset()

Changeset

public Changeset(ms.tfs.versioncontrol.clientservices._03._Changeset changeset)

Changeset

public Changeset(Changeset changeset,
                 Change change)

Changeset

public Changeset(java.lang.String owner,
                 java.lang.String comment,
                 CheckinNote checkinNote,
                 PolicyOverrideInfo policyOverride)

Changeset

public Changeset(Change[] changes,
                 java.lang.String comment,
                 CheckinNote checkinNote,
                 PolicyOverrideInfo policyOverride,
                 java.lang.String committer,
                 java.lang.String committerDisplayName,
                 java.util.Calendar date,
                 int changeSetID,
                 java.lang.String owner,
                 java.lang.String ownerDisplayName,
                 PropertyValue[] properties)
Parameters:
date - the date the changeset was created at (when it is being imported from another version control system, for example), or null to let the server use the current time. Pass null for normal check-ins.
Method Detail

getDefaultDate

public static java.util.Calendar getDefaultDate()
Gets a default date for a Changeset's construction, which is the .NET epoch. Use this date for normal changeset construction during checkin.


getWebServiceObject

public ms.tfs.versioncontrol.clientservices._03._Changeset getWebServiceObject()
Gets the web service object this class wraps. The returned object should not be modified.

Returns:
the web service object this class wraps.

setWorkItems

public void setWorkItems(WorkItem[] workItems)
Set the work items which reference this changeset. A helper method so that UI can query work items independently but set them here.

Parameters:
workItems - The work items which reference this changeset.

getWorkItems

public WorkItem[] getWorkItems()
Gets the work items which reference this changeset.

Returns:
the work items which reference this changeset.
Throws:
TECoreException - if this changeset is uncommitted (because uncommitted changesets cannot have work items which reference them).

getWorkItems

public WorkItem[] getWorkItems(WorkItemClient workItemClient)
                        throws TECoreException
Gets the work items which reference this changeset.

Parameters:
workItemClient - a work item client to use to perform the query.
Returns:
the work items which reference this changeset.
Throws:
TECoreException - if this changeset is uncommitted (because uncommitted changesets cannot have work items which reference them).

getChanges

public Change[] getChanges()

setChanges

public void setChanges(Change[] changes)

getComment

public java.lang.String getComment()

setComment

public void setComment(java.lang.String comment)

getCheckinNote

public CheckinNote getCheckinNote()

setCheckinNote

public void setCheckinNote(CheckinNote checkinNote)

getPolicyOverride

public PolicyOverrideInfo getPolicyOverride()

setPolicyOverride

public void setPolicyOverride(PolicyOverrideInfo policyOverride)

getCommitter

public java.lang.String getCommitter()

setCommitter

public void setCommitter(java.lang.String committer)

getCommitterDisplayName

public java.lang.String getCommitterDisplayName()

setCommitterDisplayName

public void setCommitterDisplayName(java.lang.String committer)

getDate

public java.util.Calendar getDate()

setDate

public void setDate(java.util.Calendar date)

getChangesetID

public int getChangesetID()

setChangesetID

public void setChangesetID(int changesetID)

getOwner

public java.lang.String getOwner()

setOwner

public void setOwner(java.lang.String owner)

getOwnerDisplayName

public java.lang.String getOwnerDisplayName()

setOwnerDisplayName

public void setOwnerDisplayName(java.lang.String owner)

getPropertyValues

public PropertyValue[] getPropertyValues()

sortChanges

public void sortChanges()
Sorts the changes in the changeset.



© 2015 Microsoft. All rights reserved.