Package de.espirit.firstspirit.access.store

Class LockException

java.lang.Object

java.lang.Throwable

java.lang.Exception

de.espirit.common.CheckedException

de.espirit.firstspirit.access.store.LockException

All Implemented Interfaces:

LocalizableError, Serializable

Direct Known Subclasses:

WorkflowLockException

public class LockException
extends CheckedException

This LockException occurs if a lock attempt or a lock attempt fails.

Since:

2.3

See Also:

• StoreElement.setLock(boolean, boolean)
• Lockable.lock()
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LockException(String message, @Nullable User user, long objectId)	Constructor for this class.
LockException(String message, @Nullable User user, long objectId, @Nullable Throwable cause)	Constructor for this class.

Method Summary

Modifier and Type	Method	Description
long	getObjectId()	Returns the id of the locked object.
long	getUserId()	Returns the user's id who has currently locked the object.
String	getUserLoginName()	Returns the user's loginname who has currently locked the object.

Methods inherited from class de.espirit.common.CheckedException

getContext, getErrorCode, getLocalizedMessage, setErrorCode

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

LockException

public LockException(String message,
 @Nullable
 @Nullable User user,
 long objectId)

Constructor for this class.

Parameters:

message - the message for this exception

user - the user which holds the lock

objectId - the id of the locked object

Since:

4.0.17

LockException

public LockException(String message,
 @Nullable
 @Nullable User user,
 long objectId,
 @Nullable
 @Nullable Throwable cause)

Constructor for this class.

Parameters:

message - the message for this exception

user - the user which holds the lock

objectId - the id of the locked object

Since:

4.0.29

Method Details

getUserLoginName

public String getUserLoginName()

Returns the user's loginname who has currently locked the object.

Returns:

the user's loginname

Since:

4.0.17

See Also:

• User.getLoginName()

getUserId

public long getUserId()

Returns the user's id who has currently locked the object.

Returns:

id of the user

Since:

4.0.17

See Also:

• Principal.getId()

getObjectId

public long getObjectId()

Returns the id of the locked object.

Returns:

id of the object

Since:

4.0.17