|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.clients.versioncontrol.workspacecache.SavedCheckin
public class SavedCheckin
Field Summary | |
---|---|
static java.lang.String |
XML_SAVED_CHECKIN
|
Constructor Summary | |
---|---|
SavedCheckin()
|
|
SavedCheckin(java.util.Collection<java.lang.String> excludedServerPaths,
java.lang.String comment,
CheckinNote checkinNotes,
WorkItemCheckedInfo[] workItemCheckedInfo,
java.lang.String policyOverrideComment)
|
|
SavedCheckin(Shelveset shelveset)
|
|
SavedCheckin(java.lang.String comment,
PendingChange[] excludedChanges,
CheckinNote checkinNotes,
WorkItemCheckedInfo[] workItemCheckedInfo,
java.lang.String policyOverrideComment)
|
Method Summary | |
---|---|
java.lang.Object |
clone()
|
WorkItemCheckedInfo[] |
getAssociateOrResolveWorkItemsCheckedInfo()
|
CheckinNote |
getCheckinNotes()
|
java.lang.String |
getComment()
|
java.lang.String[] |
getExcludedServerPaths()
|
java.lang.String |
getPolicyOverrideComment()
|
WorkItemCheckedInfo[] |
getWorkItemsCheckedInfo()
|
WorkItemCheckinInfo[] |
getWorkItemsCheckinInfo(WorkItemClient workItemClient)
Convenience method to get the checked work item info as WorkItemCheckinInfo (used for web services) instead of
WorkItemCheckedInfo (used for persistence). |
boolean |
isExcluded(java.lang.String targetServerItem)
Returns true if there if the item is excluded in this checkin. |
static SavedCheckin |
loadFromXML(org.w3c.dom.Element attemptedCheckinNode)
Creates an instance from the XML representation used in the cache file. |
void |
mergeShelvesetMetadata(Shelveset shelveset,
PendingChange[] unshelvedChanges)
Reinitialize this SavedCheckin with the metadata contined within the specified shelveset and update the check states with the the specified set of pending changes. |
void |
mergeWorkItems(WorkItemCheckedInfo[] workItems)
Merge the work items |
void |
saveAsXML(org.w3c.dom.Element parent)
Saves this instance to the XML format used in the cache file. |
void |
setCheckinNotes(CheckinNote checkinNotes)
|
void |
setComment(java.lang.String comment)
|
void |
setExcludedServerPaths(java.lang.String[] serverPaths)
|
void |
setPersistentWorkItemsCheckedInfo(WorkItemCheckedInfo[] persistentWorkItemsCheckedInfo)
|
void |
setPolicyOverrideComment(java.lang.String policyOverrideComment)
|
void |
updateCheckinItems(PendingChange[] checkedPendingChanges,
PendingChange[] uncheckedPendingChanges)
Update the saved channel info with the current check states. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String XML_SAVED_CHECKIN
"SavedCheckin"
Constructor Detail |
---|
public SavedCheckin()
public SavedCheckin(java.lang.String comment, PendingChange[] excludedChanges, CheckinNote checkinNotes, WorkItemCheckedInfo[] workItemCheckedInfo, java.lang.String policyOverrideComment)
public SavedCheckin(java.util.Collection<java.lang.String> excludedServerPaths, java.lang.String comment, CheckinNote checkinNotes, WorkItemCheckedInfo[] workItemCheckedInfo, java.lang.String policyOverrideComment)
public SavedCheckin(Shelveset shelveset)
Method Detail |
---|
public java.lang.Object clone()
clone
in class java.lang.Object
public boolean isExcluded(java.lang.String targetServerItem)
targetServerItem
- the target item to checkpublic void mergeShelvesetMetadata(Shelveset shelveset, PendingChange[] unshelvedChanges)
shelveset
- The shelveset containing the desired metadataunshelvedChanges
- The pending changes that where unshelvedpublic void mergeWorkItems(WorkItemCheckedInfo[] workItems)
workItems
- the work items to be merged (may be null
or empty)public void updateCheckinItems(PendingChange[] checkedPendingChanges, PendingChange[] uncheckedPendingChanges)
checkedPendingChanges
- the set of checked pending changes to merge with the overall set
of checked items (may be null
)uncheckedPendingChanges
- the set of unchecked pending changes to remove from the overall
set of checked items (may be null
)public static SavedCheckin loadFromXML(org.w3c.dom.Element attemptedCheckinNode)
attemptedCheckinNode
- the XML node (must not be null
)
SavedCheckin
created from the XMLpublic void saveAsXML(org.w3c.dom.Element parent)
parent
- the XML parent node (must not be null
)public java.lang.String getComment()
public void setComment(java.lang.String comment)
public java.lang.String getPolicyOverrideComment()
public void setPolicyOverrideComment(java.lang.String policyOverrideComment)
public CheckinNote getCheckinNotes()
public void setCheckinNotes(CheckinNote checkinNotes)
public WorkItemCheckedInfo[] getWorkItemsCheckedInfo()
public WorkItemCheckinInfo[] getWorkItemsCheckinInfo(WorkItemClient workItemClient)
WorkItemCheckinInfo
(used for web services) instead of
WorkItemCheckedInfo
(used for persistence).
The server may be contacted to instantiate WorkItem
s. Permissions
may restrict which work items are returned or cause exceptions. Use
getWorkItemsCheckedInfo()
to get the raw persisted information.
workItemClient
- the work item client to use to instantiate WorkItem
s (must
not be null
)
WorkItemCheckinInfo
s for this serverpublic void setPersistentWorkItemsCheckedInfo(WorkItemCheckedInfo[] persistentWorkItemsCheckedInfo)
public java.lang.String[] getExcludedServerPaths()
public void setExcludedServerPaths(java.lang.String[] serverPaths)
public WorkItemCheckedInfo[] getAssociateOrResolveWorkItemsCheckedInfo()
WorkItemCheckedInfo
objects in this
SavedCheckin
that have an action of either
CheckinWorkItemAction.RESOLVE
or
CheckinWorkItemAction.ASSOCIATE
(excludes
CheckinWorkItemAction.NONE
).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |