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

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

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

An item at a speicific version that the user wishes to get from the server.

Since:
TEE-SDK-10.1

Field Summary
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
GetRequest(ItemSpec itemSpec, VersionSpec versionSpec)
           
 
Method Summary
static GetRequest[] createOptimizedRequests(VersionControlClient client, java.lang.String[] fileSpecs, VersionSpec version)
          Take a list of file paths (for which no recursion is desired) and try to determine the optimal set of parent directories that would contain those paths if the directories were recursed.
 ItemSpec getItemSpec()
           
 VersionSpec getVersionSpec()
           
 ms.tfs.versioncontrol.clientservices._03._GetRequest getWebServiceObject()
          Gets the web service object this class wraps.
 void setItemSpec(ItemSpec itemSpec)
           
 void setVersionSpec(VersionSpec versionSpec)
           
 java.lang.String toString()
           
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
equals, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GetRequest

public GetRequest(ItemSpec itemSpec,
                  VersionSpec versionSpec)
Parameters:
itemSpec - the item to get (may be null to support the case of getting all items in the current workspace).
versionSpec - the version of the item to get.
Method Detail

getWebServiceObject

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

Returns:
the web service object this class wraps.

getItemSpec

public ItemSpec getItemSpec()

setItemSpec

public void setItemSpec(ItemSpec itemSpec)

getVersionSpec

public VersionSpec getVersionSpec()

setVersionSpec

public void setVersionSpec(VersionSpec versionSpec)

toString

public java.lang.String toString()
Overrides:
toString in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

createOptimizedRequests

public static GetRequest[] createOptimizedRequests(VersionControlClient client,
                                                   java.lang.String[] fileSpecs,
                                                   VersionSpec version)
Take a list of file paths (for which no recursion is desired) and try to determine the optimal set of parent directories that would contain those paths if the directories were recursed. Note that this mechanism also has the advantage of tracking renames if the source and target are in the same folder.

Parameters:
fileSpecs - the local item paths to get (must not be null)
version - the version of the items to get (must not be null)
Returns:
the list of GetRequest objects to pass to the client get API


© 2015 Microsoft. All rights reserved.