com.starbase.starteam
Class CheckOutResult

java.lang.Object
  |
  +--com.starbase.starteam.FileResult
        |
        +--com.starbase.starteam.CheckOutResult

public class CheckOutResult

extends FileResult

The class holds return information specific to the file checkout operation.

See Also:

checkoutToAndReturn

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
int	getExclusiveLockerID() Returns the user ID of the user that has an exclusive lock on this file.
int	getMyLockState() Returns the lock state of the file for the user performing the checkout.
int	hashCode() returns a unique hash for all instances of this type

Methods inherited from class com.starbase.starteam.FileResult

getKeywords

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getExclusiveLockerID

public int getExclusiveLockerID()

Returns the user ID of the user that has an exclusive lock on this file. Will return -1 if no one has an exclusive lock. Will also return -1 if getMyLockState() returns -1.

Returns:

the user ID of the user that has an exclusive lock on the file.

getMyLockState

public int getMyLockState()

Returns the lock state of the file for the user performing the checkout. This is not fully supported against StarTeam Server versions 4.0 and older. Will return -1 if not supported otherwise one of the MY_LOCK enum values.

Returns:

the lock state of the file for the user performing the checkout.

See Also:

PropertyNames.MY_LOCK, PropertyEnums.MY_LOCK_NOT_LOCKED_BY_ME, PropertyEnums.MY_LOCK_EXCLUSIVELY_LOCKED_BY_ME, PropertyEnums.MY_LOCK_NON_EXCLUSIVELY_LOCKED_BY_ME

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class FileResult

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class FileResult

Returns:

int a unique hash for all instances of this type