com.starbase.starteam
Interface Item.LockType

Enclosing interface:

Item

public static interface Item.LockType

Defines the constants representing the valid lock operations on items. An Item can have only one exclusive locker and multiple non-exclusive lockers. The lock state of an Item for a given user can only be one of three states: no locks of any type, exclusively locked, or non-exclusively locked.

Field Summary

static int	BREAK_FLAG Combine this value with either the UNLOCKED or EXCLUSIVE lock flags to break a lock.
static int	EXCLUSIVE Used to lock an Item exclusively for the currently logged in user.
static int	NONEXCLUSIVE Used to change a user's lock state to non-exclusively locked.
static int	UNCHANGED Used to specify no change in lock state.
static int	UNLOCKED Used to change the currently logged in user's lock state to unlocked.

Field Detail

UNLOCKED

public static final int UNLOCKED

Used to change the currently logged in user's lock state to unlocked. Note that if another user has the item exclusively locked then this will not remove that user's exclusive lock. To remove another user's lock you must combine this with the value of BREAK_FLAG. (e.g. setLock(UNLOCKED | BREAK_FLAG); )

See Also:

Constant Field Values

EXCLUSIVE

public static final int EXCLUSIVE

Used to lock an Item exclusively for the currently logged in user. An exception will be thrown if the item is already locked by another user. To break another user's exclusive lock combine this with the BREAK_FLAG (e.g. setLock(EXCLUSIVE | BREAK_FLAG); )

See Also:

Constant Field Values

NONEXCLUSIVE

public static final int NONEXCLUSIVE

Used to change a user's lock state to non-exclusively locked.

See Also:

Constant Field Values

UNCHANGED

public static final int UNCHANGED

Used to specify no change in lock state.

See Also:

Constant Field Values

BREAK_FLAG

public static final int BREAK_FLAG

Combine this value with either the UNLOCKED or EXCLUSIVE lock flags to break a lock. An exception will be thrown if the user performing the operation does not sufficient priviledges to break a lock.

See Also:

Constant Field Values