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

Interface ILockInfo

All Known Implementing Classes:
LockInfo

public interface ILockInfo

Interface describing lock information.


Method Summary
 String getClientSuppliedOwner()
          Get client supplied owner for the lock.
 Date getCreationDate()
          Get creation date.
 LockDepthType getDepth()
          Get lock depth.
 Date getExpirationDate()
          Get lock expiration timestamp.
 LockKindType getKind()
          Get lock kind.
 String getLockToken()
          Get lock token.
 String getOwner()
          Returns the unique id of the 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 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 Date getCreationDate()
Get creation date.

Returns:
creation date

getExpirationDate

public 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 String getOwner()
Returns the unique id of the lock owner.

Returns:
The unique id of the lock owner.

getClientSuppliedOwner

public 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


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.