Package ro.sync.ecss.extensions.api.webapp

Class WebappLockManager

java.lang.Object

ro.sync.ecss.extensions.api.webapp.WebappLockManager

@API(src=PRIVATE,
     type=NOT_EXTENDABLE)
public abstract class WebappLockManager
extends Object

The lock manager associated with a document.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOCKED_BY_SOMEONE_ELSE_REASON_CODE	Reason code for the editor being read-only because is locked by someone else.

Constructor Summary

Constructors

Constructor	Description
WebappLockManager()

Method Summary

Modifier and Type	Method	Description
abstract boolean	isEnabled()
abstract void	unlock()	Releases lock associated with the corresponding document.
abstract void	updateLock()	Updates the lock associated with the corresponding document.

Methods inherited from class java.lang.Object

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

Field Details

LOCKED_BY_SOMEONE_ELSE_REASON_CODE

public static final String LOCKED_BY_SOMEONE_ELSE_REASON_CODE

Reason code for the editor being read-only because is locked by someone else.

See Also:

• Constant Field Values

Constructor Details

WebappLockManager

public WebappLockManager()

Method Details

updateLock

public abstract void updateLock()
                         throws LockException

Updates the lock associated with the corresponding document.

Throws:

LockException - An exception thrown if the lock could not be updated.

unlock

public abstract void unlock()

Releases lock associated with the corresponding document.

isEnabled

public abstract boolean isEnabled()

Returns:

true if locking is enabled for the current document.