org.alfresco.service.cmr.lock

Enum LockStatus

java.lang.Object

java.lang.Enum<LockStatus>

org.alfresco.service.cmr.lock.LockStatus

All Implemented Interfaces:

Serializable, Comparable<LockStatus>

@AlfrescoPublicApi
public enum LockStatus
extends Enum<LockStatus>

Used to indicate lock status.

• NO_LOCK - Indicates that there is no lock present
• LOCKED - Indicates that the node is locked by somebody else
• LOCK_OWNER - Indicates that the node is locked and the current user has lock ownership rights
• LOCK_EXPIRED - Indicates that the lock has expired and the node can be considered to be unlocked

Author:

Roy Wetherall

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOCK_EXPIRED Indicates that the lock has expired and the node can be considered to be unlocked
LOCK_OWNER Indicates that the node is locked and you have lock ownership rights
LOCKED Indicates that the node is locked
NO_LOCK Indicates that there is no lock present

Method Summary

Modifier and Type	Method and Description
static LockStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static LockStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_LOCK

public static final LockStatus NO_LOCK

Indicates that there is no lock present

LOCKED

public static final LockStatus LOCKED

Indicates that the node is locked

LOCK_OWNER

public static final LockStatus LOCK_OWNER

Indicates that the node is locked and you have lock ownership rights

LOCK_EXPIRED

public static final LockStatus LOCK_EXPIRED

Indicates that the lock has expired and the node can be considered to be unlocked

Method Detail

values

public static LockStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LockStatus c : LockStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LockStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null