public interface LockActions extends Serializable
Modifier and Type | Field and Description |
---|---|
static String |
LOCK_CREATED |
static String |
LOCK_TIME
Deprecated.
since 5.4.2, use
LOCK_CREATED instead |
static String |
LOCKER |
Modifier and Type | Method and Description |
---|---|
Boolean |
getCanLockCurrentDoc()
Tests if the user can get the lock of the current document.
|
Boolean |
getCanLockDoc(DocumentModel document)
Tests if the user can get the lock of a document.
|
Boolean |
getCanUnlockCurrentDoc()
Tests if the user can unlock the current document.
|
Boolean |
getCanUnlockDoc(DocumentModel document)
Tests if the user can unlock a document.
|
Map<String,Serializable> |
getCurrentDocLockDetails()
Gets the details about the lock of the current document, who did the lock and when the lock took place.
|
Map<String,Serializable> |
getLockDetails(DocumentModel document)
Gets the details about the lock of a document,who did the lock and when the lock took place.
|
Action |
getLockOrUnlockAction()
Returns the action of lock or unlock for a document.
|
String |
lockCurrentDocument()
Gets the lock of the current document.
|
String |
lockDocument(DocumentModel document)
Gets the lock of the document.
|
void |
resetLockState() |
String |
unlockCurrentDocument()
Releases the lock of the current document.
|
String |
unlockDocument(DocumentModel document)
Releases the lock of the document.
|
static final String LOCKER
@Deprecated static final String LOCK_TIME
LOCK_CREATED
insteadstatic final String LOCK_CREATED
String lockCurrentDocument()
String unlockCurrentDocument()
String lockDocument(DocumentModel document)
document
- the document of which lock is to be takenString unlockDocument(DocumentModel document)
document
- the document of which lock is to be releasedBoolean getCanLockDoc(DocumentModel document)
Boolean getCanLockCurrentDoc()
Boolean getCanUnlockDoc(DocumentModel document)
Boolean getCanUnlockCurrentDoc()
Action getLockOrUnlockAction()
Map<String,Serializable> getLockDetails(DocumentModel document)
document
- the document for which this information is neededMap<String,Serializable> getCurrentDocLockDetails()
void resetLockState()
Copyright © 2015 Nuxeo SA. All rights reserved.