com.starteam.events
Class WebCacheCheckinEvent

java.lang.Object
  java.util.EventObject
      com.starteam.events.WebCacheCheckinEvent

All Implemented Interfaces:

java.io.Serializable

public final class WebCacheCheckinEvent
extends java.util.EventObject

An event triggered whenever a file is checked in through WebCacheCheckinManager.

See Also:

WebCacheCheckinListener, WebCacheCheckinManager#addCheckinListener, Serialized Form

Method Summary

CheckinManager.WebCacheCheckinManager	getCheckinManager() Gets the CheckinManager that triggered this CheckinEvent.
File.CheckInResult	getCheckinResult() Gets details describing the result of this checkin.
File.WebCacheFile	getCurrentFile() Gets the StarTeam File being checked in.
java.io.File	getCurrentWorkingFile() Gets the working file on disk where this file is being checked in from.
java.lang.Throwable	getError() The error that occurred during the checkin of this file.
java.lang.String	getErrorMessage() The error message for the error that occurred during the checkin of this file.
CheckinOptions.WebCacheCheckinOptions	getOptions() Gets the checkin options that apply to the current file.
boolean	isCanceled() Indicates whether or not the overall checkin operation has been canceled.
boolean	isFinished() Indicates whether or not the checkin operation for this file is finished.
boolean	isSuccessful() Indicates whether or not the checkin operation for this file has finished successfully.
void	setCurrentWorkingFile(java.io.File workingFile) Sets the working file on disk where this file is being checked in from.
java.lang.String	toString() Returns a String representation of this CheckinEvent (useful for debugging).

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getCheckinManager

public CheckinManager.WebCacheCheckinManager getCheckinManager()

Gets the CheckinManager that triggered this CheckinEvent.

Returns:

The CheckinManager that triggered this CheckinEvent.

See Also:

WebCacheCheckinManager

getOptions

public CheckinOptions.WebCacheCheckinOptions getOptions()

Gets the checkin options that apply to the current file.

To override any of the options for the current file, change them in the onStartFile event handler.

Returns:

The checkin options that apply to the current file.

See Also:

CheckinOptions.WebCacheCheckinOptions, WebCacheCheckinListener.startFile(com.starteam.events.WebCacheCheckinEvent)

getCurrentFile

public File.WebCacheFile getCurrentFile()

Gets the StarTeam File being checked in.

Returns:

The StarTeam File being checked in.

See Also:

File.WebCacheFile

getCurrentWorkingFile

public java.io.File getCurrentWorkingFile()

Gets the working file on disk where this file is being checked in from.

Returns:

The working file on disk where this file is being checked in from.

setCurrentWorkingFile

public void setCurrentWorkingFile(java.io.File workingFile)

Sets the working file on disk where this file is being checked in from.

Parameters:

workingFile - The working file on disk where this file is being checked in from. The working file may be changed in the onStartFile event handler.

See Also:

CheckinListener.startFile(com.starteam.events.CheckinEvent)

isFinished

public boolean isFinished()

Indicates whether or not the checkin operation for this file is finished.

Returns:

true if the checkin operation for this file is finished; false if it is still in progress. Note that the checkin may have finished, but unsuccessfully.

See Also:

WebCacheCheckinEvent.isSuccessful()

isCanceled

public boolean isCanceled()

Indicates whether or not the overall checkin operation has been canceled.

Returns:

true if the checkin operation has been canceled (for all remaining files), and false otherwise.

isSuccessful

public boolean isSuccessful()

Indicates whether or not the checkin operation for this file has finished successfully.

Returns:

true if the checkin operation for this file has finished successfully; false if the checkin is still in progress, or if it finished with an error.

See Also:

WebCacheCheckinEvent.isFinished(), WebCacheCheckinEvent.getError(), WebCacheCheckinEvent.getCheckinResult()

getCheckinResult

public File.CheckInResult getCheckinResult()

Gets details describing the result of this checkin.

Returns:

Details describing the result of this checkin, or null if the checkin of this file is still in progress or finished with an error.

See Also:

File.CheckInResult, WebCacheCheckinEvent.isFinished(), WebCacheCheckinEvent.isSuccessful()

getError

public java.lang.Throwable getError()

The error that occurred during the checkin of this file.

Returns:

The error describing the reason for failure of this checkin, if the checkin finished with an error, or null otherwise.

See Also:

WebCacheCheckinEvent.isFinished(), WebCacheCheckinEvent.isSuccessful()

getErrorMessage

public java.lang.String getErrorMessage()

The error message for the error that occurred during the checkin of this file.

Returns:

The error message for the error describing the reason for failure of this checkin, if the checkin finished with an error, or empty string otherwise.

See Also:

WebCacheCheckinEvent.isFinished(), WebCacheCheckinEvent.isSuccessful()

toString

public java.lang.String toString()

Returns a String representation of this CheckinEvent (useful for debugging).

Overrides:

toString in class java.util.EventObject

Returns:

a String representation of this CheckinEvent.