com.microsoft.tfs.core.pendingcheckin
Interface PendingCheckinPendingChanges

All Known Implementing Classes:
FilterPendingCheckinPendingChanges, StandardPendingCheckinPendingChanges

public interface PendingCheckinPendingChanges

Describes pending changes evaluated before a checkin.

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

Method Summary
 void addAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener listener)
          Adds a listener that's invoked whenever the team projects affected by this pending checkin are changed.
 void addCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener listener)
          Adds a listener that's invoked whenever the checked pending changes in the user interface are changed.
 void addCommentChangedListener(CommentChangedListener listener)
          Adds a listener that's invoked whenever the user's check-in comment changes.
 java.lang.String[] getAffectedTeamProjectPaths()
           
 PendingChange[] getAllPendingChanges()
           
 PendingChange[] getCheckedPendingChanges()
           
 java.lang.String getComment()
           
 Workspace getWorkspace()
           
 void removeAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener listener)
          Removes a listener that was previously added by addAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener) .
 void removeCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener listener)
          Removes a listener that was previously added by addCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener) .
 void removeCommentChangedListener(CommentChangedListener listener)
          Removes a listener that was previously added by addCommentChangedListener(CommentChangedListener) .
 void setAllPendingChanges(PendingChange[] changes)
          Sets the colleciton of all pending changes.
 void setCheckedPendingChanges(PendingChange[] changes)
          Sets the pending changes that are currently "checked" in the user interface for this checkin.
 void setComment(java.lang.String comment)
          Sets the comment for this checkin.
 

Method Detail

addAffectedTeamProjectsChangedListener

void addAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener listener)
Adds a listener that's invoked whenever the team projects affected by this pending checkin are changed.

Parameters:
listener - the listener to add (must not be null)

removeAffectedTeamProjectsChangedListener

void removeAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener listener)
Removes a listener that was previously added by addAffectedTeamProjectsChangedListener(AffectedTeamProjectsChangedListener) .

Parameters:
listener - the listener to remove (must not be null)

addCheckedPendingChangesChangedListener

void addCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener listener)
Adds a listener that's invoked whenever the checked pending changes in the user interface are changed.

Parameters:
listener - the listener to add (must not be null)

removeCheckedPendingChangesChangedListener

void removeCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener listener)
Removes a listener that was previously added by addCheckedPendingChangesChangedListener(CheckedPendingChangesChangedListener) .

Parameters:
listener - the listener to remove (must not be null)

addCommentChangedListener

void addCommentChangedListener(CommentChangedListener listener)
Adds a listener that's invoked whenever the user's check-in comment changes.

Parameters:
listener - the listener to add (must not be null)

removeCommentChangedListener

void removeCommentChangedListener(CommentChangedListener listener)
Removes a listener that was previously added by addCommentChangedListener(CommentChangedListener) .

Parameters:
listener - the listener to remove (must not be null)

getAffectedTeamProjectPaths

java.lang.String[] getAffectedTeamProjectPaths()
Returns:
the team project paths that are affected by changes in this pending checkin.

setAllPendingChanges

void setAllPendingChanges(PendingChange[] changes)
Sets the colleciton of all pending changes.

Parameters:
changes - the changes (must not be null)

getAllPendingChanges

PendingChange[] getAllPendingChanges()
Returns:
gets all pending changes for the workspace.

getCheckedPendingChanges

PendingChange[] getCheckedPendingChanges()
Returns:
the pending changes that are currently "checked" in the user interface for this checkin.

setCheckedPendingChanges

void setCheckedPendingChanges(PendingChange[] changes)
Sets the pending changes that are currently "checked" in the user interface for this checkin.

Parameters:
changes - the changes (must not be null)

getComment

java.lang.String getComment()
Returns:
the comment for this checkin.

setComment

void setComment(java.lang.String comment)
Sets the comment for this checkin.

Parameters:
comment - the comment (may be null)

getWorkspace

Workspace getWorkspace()
Returns:
the workspace these changes are in.


© 2015 Microsoft. All rights reserved.