com.starteam
Interface Lockable

All Known Subinterfaces:

LockableObject

All Known Implementing Classes:

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

public interface Lockable

A resource (or collection of resources) that can be 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

void	lockExclusive() Obtains an exclusive lock on this resource without attempting to break an existing lock.
void	lockExclusive(boolean breakLock) Obtains an exclusive lock on this resource.
void	lockNonExclusive() Obtains a non-exclusive lock on this resource without attempting to break an existing lock.
void	unlock() Removes the current user's lock from this resource.

Method Detail

lockExclusive

void lockExclusive()

Obtains an exclusive lock on this resource without attempting to break an existing lock. A server exception will be thrown if the lock cannot be obtained.

lockExclusive

void lockExclusive(boolean breakLock)

Obtains an exclusive lock on this resource. If breakLock is true, and another user has this resource locked, then an attempt will be made to break that lock. A server exception will be thrown if the lock cannot be obtained.

Parameters:

breakLock - true to break an existing exclusive lock owned by another user

lockNonExclusive

void lockNonExclusive()

Obtains a non-exclusive lock on this resource without attempting to break an existing lock. Other StarTeam users can also acquire a non-exclusive lock on this resource. A server exception will be thrown if the lock cannot be obtained.

unlock

void unlock()

Removes the current user's lock from this resource. If another user has an exclusive lock on the resource this method will not remove that lock.