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

Class WebappLockManager

  • @API(src=PRIVATE,
     type=NOT_EXTENDABLE)
public abstract class WebappLockManager
extends java.lang.Object
    The lock manager associated with a document.

    • Field Summary

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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 Detail

      • LOCKED_BY_SOMEONE_ELSE_REASON_CODE

        public static final java.lang.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 Detail

      • WebappLockManager

        public WebappLockManager()

    • Method Detail

      • 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.