org.nuxeo.ecm.core.api

Class Lock

java.lang.Object

org.nuxeo.ecm.core.api.Lock

All Implemented Interfaces:

Serializable

public class Lock
extends Object
implements Serializable

Information about a lock set on a document.

The lock information holds the owner, which is a user id, and the lock creation time.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Lock(Lock lock, boolean failed)
Lock(String owner, Calendar created)
Lock(String owner, Calendar created, boolean failed)

Method Summary

Modifier and Type	Method and Description
Calendar	getCreated() The creation time of the lock.
boolean	getFailed() The failure state, used for removal results.
String	getOwner() The owner of the lock.

Methods inherited from class java.lang.Object

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

Constructor Detail

Lock

public Lock(String owner,
            Calendar created,
            boolean failed)

Lock

public Lock(String owner,
            Calendar created)

Lock

public Lock(Lock lock,
            boolean failed)

Method Detail

getOwner

public String getOwner()

The owner of the lock.

Returns:

the owner, which is a user id

getCreated

public Calendar getCreated()

The creation time of the lock.

Returns:

the creation time

getFailed

public boolean getFailed()

The failure state, used for removal results.

Returns:

the failure state