Project: stp

com.ibm.rational.wvcm.stp.cc
Interface CcLockInfo


public interface CcLockInfo

Locks can be set on most Clearcase objects. CcLockInfo is an object that holds the properties that a lock can have. Note that two of the properties: LockedByUser and LockedOnDate, are set by Clearcase, so only getters are available in this interface.


Method Summary
 List<String> getExcludedUserList()
          Get list of excluded users.
 String getLockDescription()
          Get the description of the lock.
 String getLockedByUser()
          Get the name of the user who set the lock.
 Date getLockedOnDate()
          Get the date object was locked.
 boolean getObsolete()
          Check if this is an obsolete lock (should be hidden from most operations).
 void setExcludedUserList(List<String> nusers)
          Set the list of excluded users.
 void setLockDescription(String description)
          Set the description of the lock.
 void setObsolete(boolean obsolete)
          Set the obsolete state of the lock.
 

Method Detail

getExcludedUserList

List<String> getExcludedUserList()
Get list of excluded users.

Returns:
List of user names to whom the lock does not apply.

getLockDescription

String getLockDescription()
Get the description of the lock. This is not symmetric with the input to setLockDescription, because Clearcase adds its own information to the description.

Returns:
String containing the lock description.

getLockedByUser

String getLockedByUser()
Get the name of the user who set the lock.

Returns:
String containing the name of the locking user.

getLockedOnDate

Date getLockedOnDate()
Get the date object was locked.

Returns:
Date the lock was applied.

getObsolete

boolean getObsolete()
Check if this is an obsolete lock (should be hidden from most operations).

Returns:
true if the lock is obsolete, false otherwise

setExcludedUserList

void setExcludedUserList(List<String> nusers)
Set the list of excluded users. If providing an excluded user list, obsolete may not be set true.

Parameters:
nusers - List of user names to whom the lock does not apply

setLockDescription

void setLockDescription(String description)
Set the description of the lock.

Parameters:
description - Comment to be applied/displayed with the lock.

setObsolete

void setObsolete(boolean obsolete)
Set the obsolete state of the lock. If not specified, default is false. If setting obsolete to true, an excluded user list may not be provided.

Parameters:
obsolete - true if the lock is obsolete, false otherwise

Generated Fri 7-Aug-2015 10:46 PM

Copyright © IBM 2015. All rights reserved.