org.opencms.gwt.shared

Class CmsClientLock

java.lang.Object

org.opencms.gwt.shared.CmsClientLock

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class CmsClientLock
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable

Client side lock class.

Since:

8.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmsClientLock.LockType The available lock types.

Constructor Summary

Constructors

Constructor and Description
CmsClientLock() Default constructor for serialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getLockOwner() Returns the lock owner name.
CmsClientLock.LockType	getLockType() Returns the lock type.
boolean	isOwnedByUser() Returns if the current lock is owned by the current user.
void	setLockOwner(java.lang.String lockOwner) Sets the lock owner name.
void	setLockType(CmsClientLock.LockType lockType) Sets the lock type.
void	setOwnedByUser(boolean isOwnedByUser) Sets if the current lock is owned by the current user.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsClientLock

public CmsClientLock()

Default constructor for serialization.

Method Detail

getLockOwner

public java.lang.String getLockOwner()

Returns the lock owner name.

Returns:

the lock owner name

getLockType

public CmsClientLock.LockType getLockType()

Returns the lock type.

Returns:

the lock type

isOwnedByUser

public boolean isOwnedByUser()

Returns if the current lock is owned by the current user.

Returns:

if the current lock is owned by the current user

setLockOwner

public void setLockOwner(java.lang.String lockOwner)

Sets the lock owner name.

Parameters:

lockOwner - the lock owner name to set

setLockType

public void setLockType(CmsClientLock.LockType lockType)

Sets the lock type.

Parameters:

lockType - the lock type to set

setOwnedByUser

public void setOwnedByUser(boolean isOwnedByUser)

Sets if the current lock is owned by the current user.

Parameters:

isOwnedByUser - if the current lock is owned by the current user