2.2.5.9 LockTypes
The LockTypes simple type is used to represent the type of file lock. LockTypes specifies the type of lock requested or granted in a cell storage service request or cell storage service response message.
-
<xs:simpleType name="LockTypes"> <xs:union> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="None" /> <xs:enumeration value="SchemaLock" /> <xs:enumeration value="ExclusiveLock" /> </xs:restriction> </xs:simpleType> <xs:simpleType> <xs:restriction base="xs:integer"> <xs:enumeration value="0" /> <xs:enumeration value="1" /> <xs:enumeration value="2" /> </xs:restriction> </xs:simpleType> </xs:union> </xs:simpleType>
The value of LockTypes MUST be one of the values in the following table.
|
Value |
Meaning |
|---|---|
|
"None", "0" |
The string value "None" or integer value "0", indicating no type of file lock on the file. This value is only for server internal use, it will not appear in the response. |
|
"SchemaLock", "1" |
The string value "SchemaLock" or integer value "1", indicating a shared lock on the file. In a cell storage service request message, a shared lock indicates a request for sharing the lock on the file, which allows for coauthoring the file. In a cell storage service response message, a shared lock indicates that the current client is granted a shared lock on the file, which allows for coauthoring the file along with other clients. |
|
"ExclusiveLock", "2" |
The string value "ExclusiveLock" or integer value "2", indicating an exclusive lock on the file. In a cell storage service request message, an exclusive lock indicates a request for exclusive access to the file. In a cell storage service response message, an exclusive lock indicates that an exclusive lock is granted to the current client for that specific file. In a cell storage service response message, an exclusive lock also indicates that all other clients requesting an exclusive lock on that file MUST be allowed to open this file only in read-only mode. |