com.sap.portal.pcm.admin

Class ILockHandle.LockInfo

java.lang.Object
  com.sap.portal.pcm.admin.ILockHandle.LockInfo

Enclosing interface:

ILockHandle

public static class ILockHandle.LockInfo
extends Object

The class that describes the current state of a lock.

Field Summary

long	age The age of the lock in milliseconds.
String	changeListId The ID of the changelist in which the locked object is contained if it is checked out, or null if it is not checked out.
String	description The description of the locking application.
boolean	isChangeRecordingLock Determines whether this lock is a change recording lock, meaning that object is checked out in a change recording change list.
long	maxLockExpirySpan The configured value for the expiry time of a lock.
long	maxProtectionSpan The amount of time for which a newly acquired or a refreshed lock is valid.
long	protectionSpan The remaining time in seconds until the lock loses its protection against foreign takeover.
String	sessionId The session ID that was used by the lock owner when retrieving the lock.
String	userId The ID of the user who currently owns the lock, or has the locked object checked out in change recording (if active).

Constructor Summary

ILockHandle.LockInfo()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

userId

public String userId

The ID of the user who currently owns the lock, or has the locked object checked out in change recording (if active).

sessionId

public String sessionId

The session ID that was used by the lock owner when retrieving the lock.

description

public String description

The description of the locking application.

protectionSpan

public long protectionSpan

The remaining time in seconds until the lock loses its protection against foreign takeover.

When the value is 0 or negative, the object is not protected against foreign takeover. The value can be increased by the lock owner by using refreshLock.

maxProtectionSpan

public long maxProtectionSpan

The amount of time for which a newly acquired or a refreshed lock is valid.

maxLockExpirySpan

public long maxLockExpirySpan

The configured value for the expiry time of a lock.

age

public long age

The age of the lock in milliseconds.

isChangeRecordingLock

public boolean isChangeRecordingLock

Determines whether this lock is a change recording lock, meaning that object is checked out in a change recording change list.

changeListId

public String changeListId

The ID of the changelist in which the locked object is contained if it is checked out, or null if it is not checked out.

Constructor Detail

ILockHandle.LockInfo

public ILockHandle.LockInfo()

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/semantics/api	api	EP-PIN
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/pcm/admin/public/api	api	EP-PIN