com.microsoft.tfs.core.clients.versioncontrol
Class InitiallyDeletedLocalVersionUpdate

java.lang.Object
  extended by com.microsoft.tfs.core.clients.versioncontrol.InitiallyDeletedLocalVersionUpdate
All Implemented Interfaces:
ILocalVersionUpdate, IPopulatableLocalVersionUpdate, com.microsoft.tfs.util.Closable

public class InitiallyDeletedLocalVersionUpdate
extends java.lang.Object
implements IPopulatableLocalVersionUpdate, com.microsoft.tfs.util.Closable


Constructor Summary
InitiallyDeletedLocalVersionUpdate(java.lang.String sourceServerItem, int itemID, int versionLocal, java.util.Calendar versionLocalDate, int encoding, java.lang.String pendingChangeTargetServerItem)
           
 
Method Summary
 void close()
           
 void generateNewBaselineFileGuid()
           
 byte[] getBaselineFileGUID()
          The baseline file GUID for the baseline for this update
 long getBaselineFileLength()
           
 byte[] getBaselineHashValue()
          The MD5 hash value of the baseline for this update
 java.lang.String getDownloadURL()
          The URL where the baseline for this local version entry can be retrieved
 int getEncoding()
           
 int getItemID()
          Item ID corresponding to SourceServerItem (optional; but your calls to UpdateLocalVersion on a pre-Dev11 server will fail if this is not provided).
 java.lang.String getPendingChangeTargetServerItem()
          If non-null, EnsureUpdatesFullyPopulated may use QueryPendingChanges as a preferred data source for populating missing baseline information.
 java.lang.String getSourceServerItem()
          Committed server item of the item whose local version row should be updated, or the target server item if the item is uncommitted (VersionLocal == 0)
 java.lang.String getTargetLocalItem()
          The path on the local disk where this item is currently located, or null to remove it from the workspace (delete the local version row).
 int getVersionLocal()
          The version of the item in the workspace.
 long getVersionLocalDate()
           
 boolean isCommitted()
          Shorthand property for VersionLocal != 0
 boolean isFullyPopulated(boolean requireVersionLocalDate)
          Indicates whether this IPopulatableLocalVersionUpdate has all the fields populated that are necessary to call UpdateLocalVersion for a local workspace.
 boolean isSendToServer()
          Indicates whether or not this ILocalVersionUpdate is eligible to be transformed into a LocalVersionUpdate/ServerItemLocalVersionUpdate object for use in a webmethod call to UpdateLocalVersion.
 void setDownloadURL(java.lang.String value)
           
 void updateFrom(Item item)
          Updates the populatable fields of this IPopulatableLocalVersionUpdate from the data in the provided Item object.
 void updateFrom(PendingChange pendingChange)
          Updates the populatable fields of this IPopulatableLocalVersionUpdate from the data in the provided PendingChange object.
 void updateFrom(com.microsoft.tfs.core.clients.versioncontrol.internal.localworkspace.WorkspaceLocalItem lvExisting)
          Updates the populatable fields of this IPopulatableLocalVersionUpdate from the data in the provided WorkspaceLocalItem object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InitiallyDeletedLocalVersionUpdate

public InitiallyDeletedLocalVersionUpdate(java.lang.String sourceServerItem,
                                          int itemID,
                                          int versionLocal,
                                          java.util.Calendar versionLocalDate,
                                          int encoding,
                                          java.lang.String pendingChangeTargetServerItem)
Method Detail

isSendToServer

public boolean isSendToServer()
Description copied from interface: ILocalVersionUpdate
Indicates whether or not this ILocalVersionUpdate is eligible to be transformed into a LocalVersionUpdate/ServerItemLocalVersionUpdate object for use in a webmethod call to UpdateLocalVersion. If false, the object is intended to be consumed only by the local workspaces implementation of UpdateLocalVersion.

Specified by:
isSendToServer in interface ILocalVersionUpdate

isCommitted

public boolean isCommitted()
Description copied from interface: ILocalVersionUpdate
Shorthand property for VersionLocal != 0

Specified by:
isCommitted in interface ILocalVersionUpdate

getSourceServerItem

public java.lang.String getSourceServerItem()
Description copied from interface: ILocalVersionUpdate
Committed server item of the item whose local version row should be updated, or the target server item if the item is uncommitted (VersionLocal == 0)

Specified by:
getSourceServerItem in interface ILocalVersionUpdate

getItemID

public int getItemID()
Description copied from interface: ILocalVersionUpdate
Item ID corresponding to SourceServerItem (optional; but your calls to UpdateLocalVersion on a pre-Dev11 server will fail if this is not provided).

Specified by:
getItemID in interface ILocalVersionUpdate

getTargetLocalItem

public java.lang.String getTargetLocalItem()
Description copied from interface: ILocalVersionUpdate
The path on the local disk where this item is currently located, or null to remove it from the workspace (delete the local version row).

Specified by:
getTargetLocalItem in interface ILocalVersionUpdate

getVersionLocal

public int getVersionLocal()
Description copied from interface: ILocalVersionUpdate
The version of the item in the workspace. If zero, the item is uncommitted (a pending add or branch).

Specified by:
getVersionLocal in interface ILocalVersionUpdate

getEncoding

public int getEncoding()

getVersionLocalDate

public long getVersionLocalDate()

getBaselineHashValue

public byte[] getBaselineHashValue()
Description copied from interface: IPopulatableLocalVersionUpdate
The MD5 hash value of the baseline for this update

Specified by:
getBaselineHashValue in interface IPopulatableLocalVersionUpdate

getBaselineFileLength

public long getBaselineFileLength()

getBaselineFileGUID

public byte[] getBaselineFileGUID()
Description copied from interface: IPopulatableLocalVersionUpdate
The baseline file GUID for the baseline for this update

Specified by:
getBaselineFileGUID in interface IPopulatableLocalVersionUpdate

getDownloadURL

public java.lang.String getDownloadURL()
Description copied from interface: IPopulatableLocalVersionUpdate
The URL where the baseline for this local version entry can be retrieved

Specified by:
getDownloadURL in interface IPopulatableLocalVersionUpdate

setDownloadURL

public void setDownloadURL(java.lang.String value)
Specified by:
setDownloadURL in interface IPopulatableLocalVersionUpdate

getPendingChangeTargetServerItem

public java.lang.String getPendingChangeTargetServerItem()
Description copied from interface: IPopulatableLocalVersionUpdate
If non-null, EnsureUpdatesFullyPopulated may use QueryPendingChanges as a preferred data source for populating missing baseline information. The pending change to be queried will be the one on this target server item.

Specified by:
getPendingChangeTargetServerItem in interface IPopulatableLocalVersionUpdate

close

public void close()
Specified by:
close in interface com.microsoft.tfs.util.Closable

isFullyPopulated

public boolean isFullyPopulated(boolean requireVersionLocalDate)
Description copied from interface: IPopulatableLocalVersionUpdate
Indicates whether this IPopulatableLocalVersionUpdate has all the fields populated that are necessary to call UpdateLocalVersion for a local workspace.

Specified by:
isFullyPopulated in interface IPopulatableLocalVersionUpdate

updateFrom

public void updateFrom(Item item)
Description copied from interface: IPopulatableLocalVersionUpdate
Updates the populatable fields of this IPopulatableLocalVersionUpdate from the data in the provided Item object.

Specified by:
updateFrom in interface IPopulatableLocalVersionUpdate
Parameters:
item - Data source to update from

updateFrom

public void updateFrom(com.microsoft.tfs.core.clients.versioncontrol.internal.localworkspace.WorkspaceLocalItem lvExisting)
Description copied from interface: IPopulatableLocalVersionUpdate
Updates the populatable fields of this IPopulatableLocalVersionUpdate from the data in the provided WorkspaceLocalItem object.

Specified by:
updateFrom in interface IPopulatableLocalVersionUpdate
Parameters:
lvExisting - Data source to update from

updateFrom

public void updateFrom(PendingChange pendingChange)
Description copied from interface: IPopulatableLocalVersionUpdate
Updates the populatable fields of this IPopulatableLocalVersionUpdate from the data in the provided PendingChange object.

Specified by:
updateFrom in interface IPopulatableLocalVersionUpdate
Parameters:
pendingChange - Data source to update from

generateNewBaselineFileGuid

public void generateNewBaselineFileGuid()


© 2015 Microsoft. All rights reserved.