com.starteam
Interface LockableObject

All Superinterfaces:

Lockable

All Known Implementing Classes:

Audit, ChangePackage, ChangeRequest, Concept, File, Folder, Item, LinkToTraceAdapter, Requirement, Sprint, Story, Task, Topic, Trace, TreeItem, VCMFolder, ViewMember, WhiteBoard

public interface LockableObject
extends Lockable

A resource (or collection of resources) that can be locked and the context, i.e. the locker who has the resource locked Important Note: This interface is not intended to be implemented by client applications. We reserve the right to add methods in the future. Applications that implement this interface may not be compatible with future versions of the StarTeam SDK.

Method Summary

User	getLocker() Gets the User that has this resource exclusively locked, or -1 if no one has it locked.
ViewMember.LockType	getMyLockType() Returns the lock status of this ViewMember for the currently logged in user.

Methods inherited from interface com.starteam.Lockable

lockExclusive, lockExclusive, lockNonExclusive, unlock

Method Detail

getLocker

User getLocker()

Gets the User that has this resource exclusively locked, or -1 if no one has it locked.

Returns:

The exclusive locker of this resource.

getMyLockType

ViewMember.LockType getMyLockType()

Returns the lock status of this ViewMember for the currently logged in user. It will be one of EXCLUSIVE, NON_EXCLUSIVE, or UNLOCKED.

Returns:

the lock status of the ViewMember for the currently logged in user.

See Also:

ViewMember.LockType.EXCLUSIVE, ViewMember.LockType.NON_EXCLUSIVE, ViewMember.LockType.UNLOCKED