com.sapportals.wcm.repository

Class LockedException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.sapportals.wcm.WcmException
              com.sapportals.wcm.util.content.ContentException
                  com.sapportals.wcm.repository.ResourceException
                      com.sapportals.wcm.repository.LockedException

All Implemented Interfaces:

Serializable

public class LockedException
extends ResourceException

The resource was locked by another user.

Copyright (c) 2001-2004 SAP AG

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sapportals.wcm.WcmException

ex

Constructor Summary

LockedException(LockInPlaceException newEx, String userID, RID indirectlyLockedBy, String indirectLockToken)
This constructor is used by the framework to use this exception as a wrapper for a new exception class of the repository manager API.

LockedException(String msg, RID rid, String userID)

LockedException(String msg, RID rid, String userID, RID indirectlyLockedBy, String indirectLockToken)

LockedException(String msg, URI resourceID, String userID)
Deprecated. as of NW04.

Method Summary

String	getIndirectLockToken()
RID	getIndirectlyLockedRid()
String	getUserID()

Methods inherited from class com.sapportals.wcm.repository.ResourceException

fillInStackTrace, getLocalizedMessage, getMessage, getNextResourceException, getResourceID, getRID, printStackTrace, printStackTrace, printStackTrace, setNextResourceException, toString

Methods inherited from class com.sapportals.wcm.WcmException

getContainedException, isLogged, setContainedException

Methods inherited from class java.lang.Throwable

getCause, getStackTrace, initCause, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

LockedException

public LockedException(String msg,
                       URI resourceID,
                       String userID)

Deprecated. as of NW04.

LockedException

public LockedException(String msg,
                       RID rid,
                       String userID)

Parameters:

msg - Message

rid - RID of resource with conflicting locks

userID - user who holds the conflicting lock

LockedException

public LockedException(String msg,
                       RID rid,
                       String userID,
                       RID indirectlyLockedBy,
                       String indirectLockToken)

Parameters:

msg - Message

rid - RID of resource with conflicting locks

userID - user who holds the conflicting lock

indirectlyLockedBy - if the resource is indirectly locked by means of a deep lock on a parent, the RID of the resource holding that lock should be specified here (otherwise null)

indirectLockToken - lock token identifying the indirect lock with which this request collided (otherwise null)

LockedException

public LockedException(LockInPlaceException newEx,
                       String userID,
                       RID indirectlyLockedBy,
                       String indirectLockToken)

This constructor is used by the framework to use this exception as a wrapper for a new exception class of the repository manager API.

Parameters:

newEx - The new exception.

Method Detail

getUserID

public String getUserID()

Returns:

user who holds the conflicting lock (or null when unknown)

getIndirectlyLockedRid

public RID getIndirectlyLockedRid()

Returns:

if the resource is indirecly locked by means of a deep lock on a parent, the RID of that parent resource (or null when unknown or not applicable)

getIndirectLockToken

public String getIndirectLockToken()

Returns:

if the resource is indirecly locked by means of a deep lock on a parent, the lock token for that lock (or null when unknown or not applicable)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM