com.microsoft.tfs.core.pendingcheckin
Interface PendingCheckinNotes

All Known Implementing Classes:
StandardPendingCheckinNotes

public interface PendingCheckinNotes

Contains the check-in notes in the current pending change set.

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

Method Summary
 void addNotesChangedListener(NotesChangedListener listener)
          Adds a listener that's invoked whenever user's check-in notes in the user interface are changed (via setCheckinNotes(CheckinNote).
 CheckinNoteFailure[] evaluate()
          Evaluates the checkin notes that have been set on this object.
 CheckinNote getCheckinNotes()
           
 CheckinNoteFieldDefinition[] getFieldDefinitions()
          Gets the field definitions that the checkin note was last evaluated against.
 void removeNotesChangedListener(NotesChangedListener listener)
          Removes a listener that was previously added by addNotesChangedListener(NotesChangedListener).
 void setCheckinNotes(CheckinNote note)
           
 

Method Detail

addNotesChangedListener

void addNotesChangedListener(NotesChangedListener listener)
Adds a listener that's invoked whenever user's check-in notes in the user interface are changed (via setCheckinNotes(CheckinNote).

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

removeNotesChangedListener

void removeNotesChangedListener(NotesChangedListener listener)
Removes a listener that was previously added by addNotesChangedListener(NotesChangedListener).

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

evaluate

CheckinNoteFailure[] evaluate()
Evaluates the checkin notes that have been set on this object. It is up to implementations of this class to provide a means of configuring the TFS connection and other version control information required to evaluate notes.

Returns:
any failures encountered during evaluation.

getCheckinNotes

CheckinNote getCheckinNotes()
Returns:
the checkin notes to evaluate.

setCheckinNotes

void setCheckinNotes(CheckinNote note)
Parameters:
note - the checkin notes to evaluate (must not be null)

getFieldDefinitions

CheckinNoteFieldDefinition[] getFieldDefinitions()
Gets the field definitions that the checkin note was last evaluated against. If evaluate() has not yet been called, returns null.

Returns:
the field definitions (only non-null after evaluate() has been called).


© 2015 Microsoft. All rights reserved.