com.starbase.starteam
Interface CheckinListener

All Superinterfaces:

java.util.EventListener

public interface CheckinListener

extends java.util.EventListener

Event-listener interface for checkout events.

See Also:

CheckinManager.addCheckinListener(com.starbase.starteam.CheckinListener), CheckinEvent

Method Summary

void	onNotifyProgress(CheckinEvent event) Triggered during the checkin operation, to provide the client application with updated information about the progress of the operation.
void	onStartFile(CheckinEvent event) Triggered once per file, at the start of the checkin operation for that file.

Method Detail

onStartFile

public void onStartFile(CheckinEvent event)

Triggered once per file, at the start of the checkin operation for that file. This provides the client application with an opportunity to override any of the checkin parameters on a file-by-file basis, or to cancel the checkin process.

Parameters:

event - The corresponding checkin event.

See Also:

CheckinEvent, CheckinEvent.getOptions(), CheckinManager.setCanceled()

onNotifyProgress

public void onNotifyProgress(CheckinEvent event)

Triggered during the checkin operation, to provide the client application with updated information about the progress of the operation.

If the checkin of a given file completes successfully, then the onNotifyProgress event is triggered with CheckinEvent.isFinished() and CheckinEvent.isSuccessfull() both returning true.

If the checkin of a given file terminates abnormally, then the onNotifyProgress event is triggered with CheckinEvent.isSuccessful() returning false.

If the checkin operation is canceled, then the onNotifyProgress event is triggered once for every file that has not yet completed. In this case, CheckinEvent.isCanceled() returns true.

Parameters:

event - The corresponding checkin event.

See Also:

CheckinEvent, CheckinEvent#getProgress, CheckinEvent.isFinished(), CheckinEvent.isSuccessful(), CheckinEvent.isCanceled()