com.sap.netweaver.bc.rf.common.lock
Interface ILockInfo

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.common_api.jar]

All Known Implementing Classes:

LockInfo

public interface ILockInfo

Interface describing lock information.

Method Summary

java.lang.String	getClientSuppliedOwner() Get client supplied owner for the lock.
java.util.Date	getCreationDate() Get creation date.
LockDepthType	getDepth() Get lock depth.
java.util.Date	getExpirationDate() Get lock expiration timestamp.
LockKindType	getKind() Get lock kind.
java.lang.String	getLockToken() Get lock token.
java.lang.String	getOwner() Get user id of lock owner.
IRid	getRid() Get resource id this lock info is valid for.
LockScopeType	getScope() Get lock scope.
long	getTimeout() Get lock timeout in milliseconds.
long	getTimeRemaining() Get time remaining until lock expires.

Method Detail

getLockToken

public java.lang.String getLockToken()

Get lock token. The lock token must be either an absolute URI (as defined in RFC2396 or a relative URI reference (in which case the opaquelocktoken URI scheme is assumed).

Returns:

lock token

getRid

public IRid getRid()

Get resource id this lock info is valid for.

Returns:

resource id

getDepth

public LockDepthType getDepth()

Get lock depth.

Returns:

LockDepthType of lock

getScope

public LockScopeType getScope()

Get lock scope.

Returns:

LockScopeType of lock

getKind

public LockKindType getKind()

Get lock kind.

Returns:

LockKindType of lock

getCreationDate

public java.util.Date getCreationDate()

Get creation date.

Returns:

creation date

getExpirationDate

public java.util.Date getExpirationDate()

Get lock expiration timestamp.

Returns:

lock expiration timestamp

getTimeRemaining

public long getTimeRemaining()

Get time remaining until lock expires.

Returns:

time remaining until lock expires (or -1 for "infinite").

getTimeout

public long getTimeout()

Get lock timeout in milliseconds.

Returns:

lock timeout in milliseconds

getOwner

public java.lang.String getOwner()

Get user id of lock owner.

Returns:

user id of lock owner

getClientSuppliedOwner

public java.lang.String getClientSuppliedOwner()

Get client supplied owner for the lock. A client can submit his own owner information that should be returned upon lock discovery. If present, the format must be the XML serialization of a DAV:owner element.

Returns:

client supplied owner for the lock