com.starteam.events
Class CommandProcessorStatusEvent

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

All Implemented Interfaces:

java.io.Serializable

public final class CommandProcessorStatusEvent
extends java.util.EventObject

An event triggered whenever a checkin or checkout command is executed through the CommandProcessor The event is triggered in interactive mode, if the file status is such that a checkin or a checkout would fail for instance, the status if either Merge or Unknown

See Also:

File.Status, Serialized Form

Method Summary

void	cancel() cancel execution of the command
void	force() force this file to be checked in (or checked out) during execution of the command This is the default expected behavior
File.Status	getStatus() returns the status of the StarTeam file relative to the working file on disk In case of a checkout command (co), the status will be one of MERGE, UNKNOWN or MODIFIED In case of a checkin command (ci), the status will be one of MERGE, UNKNOWN or OUT OF DATE
java.io.File	getWorkingFileOnDisk() returns the working file on disk in whose context this event is being fired
boolean	isCanceled() return true if the command was canceled during execution
boolean	isForced() return true if this file should be force checked in (or checked out) during execution
boolean	isSkipped() return true if this file should be skipped during execution
void	skip() skip this file during execution of the command
java.lang.String	toString()

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

getWorkingFileOnDisk

public java.io.File getWorkingFileOnDisk()

returns the working file on disk in whose context this event is being fired

Returns:

the working file on disk in whose context this event is being fired

getStatus

public File.Status getStatus()

returns the status of the StarTeam file relative to the working file on disk In case of a checkout command (co), the status will be one of MERGE, UNKNOWN or MODIFIED In case of a checkin command (ci), the status will be one of MERGE, UNKNOWN or OUT OF DATE

Returns:

the status of the StarTeam file relative to the working file on disk The user may choose to skip the file, force checkin (or checkout) the file, or cancel the operation

isCanceled

public boolean isCanceled()

return true if the command was canceled during execution

Returns:

true if the command was canceled during execution

cancel

public void cancel()

cancel execution of the command

isSkipped

public boolean isSkipped()

return true if this file should be skipped during execution

Returns:

true if this file should be skipped during execution

skip

public void skip()

skip this file during execution of the command

force

public void force()

force this file to be checked in (or checked out) during execution of the command This is the default expected behavior

isForced

public boolean isForced()

return true if this file should be force checked in (or checked out) during execution

Returns:

true if this file should be force checked in (or checked out) during execution

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject