com.starteam
Class File.CheckOutResult

java.lang.Object
  extended by com.starteam.File.Result
      extended by com.starteam.File.CheckOutResult
Enclosing class:
File

public static final class File.CheckOutResult
extends File.Result

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


Method Summary
 User getExclusiveLocker()
          Returns the user object that has an exclusive lock on this file.
 ViewMember.MyLock getMyLock()
          Returns the lock state of the file for the user performing the checkout.
 
Methods inherited from class com.starteam.File.Result
getKeywords
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getExclusiveLocker

public User getExclusiveLocker()
Returns the user object that has an exclusive lock on this file. Will return null if no one has an exclusive lock. Will also return null if getMyLock() returns null.

Returns:
the User object who has an exclusive lock on the file.

getMyLock

public ViewMember.MyLock getMyLock()
Returns the lock state of the file for the user performing the checkout.

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


StarTeam SDK 14.0, Build 21
Copyright © 2003-2012 Borland Software Corporation. All rights reserved.