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

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

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

A server-side collection of pending changes and associated metadata.

Since:
TEE-SDK-10.1
Thread-safety:
thread-compatible

Field Summary
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
Shelveset(ms.tfs.versioncontrol.clientservices._03._Shelveset shelveset)
           
Shelveset()
           
Shelveset(java.lang.String name, java.lang.String owner, java.lang.String ownerDisplayName, java.lang.String comment, java.lang.String policyOverrideComment, CheckinNote checkinNote, VersionControlLink[] links, java.util.Calendar creationDate, boolean changesExcluded, PropertyValue[] propertyValues)
           
Shelveset(java.lang.String name, java.lang.String owner, java.lang.String ownerDisplayName, java.lang.String comment, java.lang.String policyOverrideComment, CheckinNote checkinNote, WorkItemCheckedInfo[] checkedInfo, java.util.Calendar creationDate, boolean changesExcluded, PropertyValue[] propertyValues)
           
Shelveset(java.lang.String name, java.lang.String owner, java.lang.String ownerDisplayName, java.lang.String comment, java.lang.String policyOverrideComment, CheckinNote checkinNote, WorkItemCheckinInfo[] checkedInfo, java.util.Calendar creationDate, boolean changesExcluded, PropertyValue[] propertyValues)
           
 
Method Summary
 boolean areChangesExcluded()
           
 WorkItemCheckedInfo[] getBriefWorkItemInfo()
          Gets brief work item information including only the IDs and the actions on each included with the shelveset.
 CheckinNote getCheckinNote()
           
 java.lang.String getComment()
           
 java.util.Calendar getCreationDate()
           
 java.lang.String getName()
           
 java.lang.String getOwnerDisplayName()
           
 java.lang.String getOwnerName()
           
 java.lang.String getPolicyOverrideComment()
           
 PropertyValue[] getPropertyValues()
           
 ms.tfs.versioncontrol.clientservices._03._Shelveset getWebServiceObject()
          Gets the web service object this class wraps.
 WorkItemCheckinInfo[] getWorkItemInfo(WorkItemClient workItemClient)
          Gets work items associated with the shelveset.
 void setOwnerDisplayName(java.lang.String owner)
          Set the owner display name.
 void setOwnerName(java.lang.String owner)
          Set the owner name.
 
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
 

Constructor Detail

Shelveset

public Shelveset()

Shelveset

public Shelveset(ms.tfs.versioncontrol.clientservices._03._Shelveset shelveset)

Shelveset

public Shelveset(java.lang.String name,
                 java.lang.String owner,
                 java.lang.String ownerDisplayName,
                 java.lang.String comment,
                 java.lang.String policyOverrideComment,
                 CheckinNote checkinNote,
                 VersionControlLink[] links,
                 java.util.Calendar creationDate,
                 boolean changesExcluded,
                 PropertyValue[] propertyValues)

Shelveset

public Shelveset(java.lang.String name,
                 java.lang.String owner,
                 java.lang.String ownerDisplayName,
                 java.lang.String comment,
                 java.lang.String policyOverrideComment,
                 CheckinNote checkinNote,
                 WorkItemCheckedInfo[] checkedInfo,
                 java.util.Calendar creationDate,
                 boolean changesExcluded,
                 PropertyValue[] propertyValues)

Shelveset

public Shelveset(java.lang.String name,
                 java.lang.String owner,
                 java.lang.String ownerDisplayName,
                 java.lang.String comment,
                 java.lang.String policyOverrideComment,
                 CheckinNote checkinNote,
                 WorkItemCheckinInfo[] checkedInfo,
                 java.util.Calendar creationDate,
                 boolean changesExcluded,
                 PropertyValue[] propertyValues)
Method Detail

getWebServiceObject

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

Returns:
the web service object this class wraps.

getName

public java.lang.String getName()
Returns:
the shelveset name.

getOwnerName

public java.lang.String getOwnerName()
Returns:
the owner name.

setOwnerName

public void setOwnerName(java.lang.String owner)
Set the owner name.


getOwnerDisplayName

public java.lang.String getOwnerDisplayName()
Returns:
the owner display name.

setOwnerDisplayName

public void setOwnerDisplayName(java.lang.String owner)
Set the owner display name.


getCreationDate

public java.util.Calendar getCreationDate()
Returns:
the date and time that the shelveset was shelved.

getComment

public java.lang.String getComment()
Returns:
the comment that describes the shelveset.

getCheckinNote

public CheckinNote getCheckinNote()
Returns:
the check-in note that is associated with this shelveset.

getPolicyOverrideComment

public java.lang.String getPolicyOverrideComment()
Returns:
user-supplied comment that describes why the policy failed.

getPropertyValues

public PropertyValue[] getPropertyValues()

getBriefWorkItemInfo

public WorkItemCheckedInfo[] getBriefWorkItemInfo()
Gets brief work item information including only the IDs and the actions on each included with the shelveset. Unlike getWorkItemInfo(WorkItemClient), this method does not access the server.


getWorkItemInfo

public WorkItemCheckinInfo[] getWorkItemInfo(WorkItemClient workItemClient)
Gets work items associated with the shelveset.

Parameters:
workItemClient - a work item client to resolve information with (must not be null)
Returns:
the work items that are associated with the shelveset

areChangesExcluded

public boolean areChangesExcluded()
Returns:
true if some changes were excluded from this shelveset, false otherwise
Since:
TFS 2008


© 2015 Microsoft. All rights reserved.