PersistentLock.php
1 <?php
2 /**
3  * wCMF - wemove Content Management Framework
4  * Copyright (C) 2005-2020 wemove digital solutions GmbH
5  *
6  * Licensed under the terms of the MIT License.
7  *
8  * See the LICENSE file distributed with this work for
9  * additional information.
10  */
12 
13 /**
14  * PersistentLock defines the interface for locks that may be persisted
15  * (e.g. for pessimistic offline locking).
16  *
17  * @author ingo herwig <ingo@wemove.com>
18  */
19 interface PersistentLock {
20 
21  /**
22  * Get the object id of the locked object.
23  * @return ObjectId of the locked object.
24  */
25  public function getObjectId();
26 
27  /**
28  * Get the login of the user who holds the lock.
29  * @return The login of the user.
30  */
31  public function getLogin();
32 
33  /**
34  * Get the creation date/time of the lock.
35  * @return The creation date/time of the lock.
36  */
37  public function getCreated();
38 }
39 ?>
getObjectId()
Get the object id of the locked object.
getLogin()
Get the login of the user who holds the lock.
PersistentLock defines the interface for locks that may be persisted (e.g.
getCreated()
Get the creation date/time of the lock.