com.starbase.starteam
Interface CheckoutListener

All Superinterfaces:

java.util.EventListener

public interface CheckoutListener

extends java.util.EventListener

Event-listener interface for checkout events.

See Also:

CheckoutManager.addCheckoutListener(com.starbase.starteam.CheckoutListener), CheckoutEvent

Method Summary

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

Method Detail

onStartFile

public void onStartFile(CheckoutEvent event)

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

Parameters:

event - The corresponding checkout event.

See Also:

CheckoutEvent, CheckoutEvent.getOptions(), CheckoutManager.setCanceled()

onNotifyProgress

public void onNotifyProgress(CheckoutEvent event)

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

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

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

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

Parameters:

event - The corresponding checkout event.

See Also:

CheckoutEvent, CheckoutEvent.getProgress(), CheckoutEvent.isFinished(), CheckoutEvent.isSuccessful(), CheckoutEvent.isCanceled()