An entity may be locked by an actor, and the Lock may be jointly held by a set of owners; a lock may be owned by either an actor or a group. The locking actor must have write access on the entity. Actors not included in this owner set are prevented from modifying the properties of the locked entity. A Lock has an optional timeout value, after which point the lock is automatically released. The Lock creator, Lock holders, and users that have administrative privileges on the locked entity (such as workspace coordinators) may release the lock manually. Every Lock has a lock type associated with it. A given set of owners may hold two locks of different types on an entity simultaneously, but may not hold two locks of the same type on a single entity. If the entity on which a Lock is held is a container, then the Lock is also in effect for all entities contained within the container. Since access control for locks is governed by the lock holders, the standard Beehive-wide access control members should be ignored for this entity.

Below are examples in JSON and XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

<xs:complexType name="lock">
    <xs:complexContent>
        <xs:extension base="tns:entity">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="lockHolders" nillable="true" type="tns:accessor"/>
                <xs:element minOccurs="0" name="lockType" type="tns:lockType"/>
                <xs:element minOccurs="0" name="lockedEntity" type="tns:entity"/>
                <xs:element minOccurs="0" name="properties" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="timeout" type="xs:dateTime"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

The following data represents the references to lock