Package org.opencms.lock
Class CmsLockType
java.lang.Object
org.opencms.util.A_CmsModeIntEnumeration
org.opencms.lock.CmsLockType
- All Implemented Interfaces:
Serializable
Indicates the different possible lock types.
- Since:
- 7.0.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final CmsLockType
A lock that allows the user to edit the resource's structure record, it's resource record, and its content record.static final CmsLockType
A lock that is inherited from a locked parent folder.static final CmsLockType
A lock that indicates that the resource is waiting to be published in the publish queue.static final CmsLockType
A lock that is 'shallow', i.e.static final CmsLockType
A lock that allows the user to edit the resource's structure record only, but not it's resource record nor content record.static final CmsLockType
A lock that allows the user to edit the resource's structure record only, but not it's resource record nor content record.protected static final CmsLockType
Type of the NULL system lock.static final CmsLockType
A temporary exclusive lock that allows the user to edit the resource's structure record, it's resource record, and its content record.static final CmsLockType
Type of the NULL lock obtained byCmsLock.getNullLock()
. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returnstrue
if this is an directly inherited lock.boolean
Returnstrue
if this is an exclusive (or temporary exclusive) lock.boolean
Returnstrue
if this is an inherited lock, which may either be directly or shared inherited.boolean
Returnstrue
if this is a persistent lock that should be saved when the systems shuts down.boolean
Returnstrue
if this is a publish lock.boolean
Returns true if this is a shallow lock.boolean
isShared()
Returnstrue
if this is a shared lock.boolean
Returnstrue
if this is an shared exclusive lock.boolean
Returnstrue
if this is an shared inherited lock.boolean
isSystem()
Returnstrue
if this is a system (2nd level) lock.boolean
Returnstrue
if this is a temporary lock.boolean
Returnstrue
if this lock is in fact unlocked.toString()
static CmsLockType
valueOf
(int type) Returns the lock type for the given type value.Methods inherited from class org.opencms.util.A_CmsModeIntEnumeration
equals, getMode, hashCode
-
Field Details
-
EXCLUSIVE
A lock that allows the user to edit the resource's structure record, it's resource record, and its content record.This lock is assigned to files that are locked via the context menu.
-
INHERITED
A lock that is inherited from a locked parent folder. -
PUBLISH
A lock that indicates that the resource is waiting to be published in the publish queue. -
SHALLOW
A lock that is 'shallow', i.e. not inherited on child resources. -
SHARED_EXCLUSIVE
A lock that allows the user to edit the resource's structure record only, but not it's resource record nor content record.This lock is assigned to files if a sibling of the resource record has already an exclusive lock.
-
SHARED_INHERITED
A lock that allows the user to edit the resource's structure record only, but not it's resource record nor content record.This lock is assigned to resources that already have a shared exclusive lock, and then inherit a lock because one of it's parent folders gets locked.
-
TEMPORARY
A temporary exclusive lock that allows the user to edit the resource's structure record, it's resource record, and its content record.This lock is identical to the
EXCLUSIVE
lock, but it is automatically removed after a user is logged out. -
UNLOCKED
Type of the NULL lock obtained byCmsLock.getNullLock()
. -
SYSTEM_UNLOCKED
Type of the NULL system lock.
-
-
Method Details
-
valueOf
Returns the lock type for the given type value.This is used only for serialization and should not be accessed for other purposes.
- Parameters:
type
- the type value to get the lock type for- Returns:
- the lock type for the given type value
-
isDirectlyInherited
Returnstrue
if this is an directly inherited lock.- Returns:
true
if this is an directly inherited lock
-
isExclusive
Returnstrue
if this is an exclusive (or temporary exclusive) lock.- Returns:
true
if this is an exclusive (or temporary exclusive) lock
-
isInherited
Returnstrue
if this is an inherited lock, which may either be directly or shared inherited.- Returns:
true
if this is an inherited lock, which may either be directly or shared inherited
-
isPersistent
Returnstrue
if this is a persistent lock that should be saved when the systems shuts down.- Returns:
true
if this is a persistent lock that should be saved when the systems shuts down
-
isPublish
Returnstrue
if this is a publish lock.- Returns:
true
if this is a publish lock
-
isShallow
Returns true if this is a shallow lock.- Returns:
- true if this is a shallow lock
-
isSystem
Returnstrue
if this is a system (2nd level) lock.- Returns:
true
if this is a system (2nd level) lock
-
isTemporary
Returnstrue
if this is a temporary lock.- Returns:
true
if this is a temporary lock
-
isUnlocked
Returnstrue
if this lock is in fact unlocked.Only if this is
true
, the result lock is equal to theNULL
lock, which can be obtained byCmsLock.getNullLock()
.- Returns:
true
if this lock is in fact unlocked
-
toString
- Overrides:
toString
in classA_CmsModeIntEnumeration
- See Also:
-