com.sapportals.wcm.repository

Interface ILockInfo

All Known Implementing Classes:

ExtendedLockInfo, LockInfo

public interface ILockInfo

Information about a specific lock.

Copyright 2004 SAP AG

Method Summary

XMLMarkup	getClientSuppliedOwner() A client can submit his own owner information that SHOULD be returned upon lock discovery.
Date	getCreated()
LockDepth	getDepth()
Date	getExpiration()
String	getLockToken() 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).
String	getOwner() Returns the user id of the lock owner.
LockScope	getScope()
int	getTimeout()
LockType	getType()
long	timeRemaining()

Method Detail

getType

public LockType getType()

Returns:

LockType of lock.

getScope

public LockScope getScope()

Returns:

LockScope of lock.

getCreated

public Date getCreated()

Returns:

creation timestamp

getDepth

public LockDepth getDepth()

Returns:

LockDepth of lock.

getTimeout

public int getTimeout()

Returns:

get timeout of seconds.

getOwner

public String getOwner()

Returns the user id of the lock owner.

Returns:

The user id of the lock owner as specified by the com.sapportals.usermanagement API.

getExpiration

public Date getExpiration()

Returns:

expiration time of lock.

timeRemaining

public long timeRemaining()

Returns:

time remaining until expiry in seconds (or -1 for "infinite").

getLockToken

public String getLockToken()

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.

getClientSuppliedOwner

public XMLMarkup getClientSuppliedOwner()

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:

lock owner information as submitted by client (may be null if not available).