2.3.3.4 ExclusiveLockSubRequestDataOptionalAttributes
The ExclusiveLockSubRequestDataOptionalAttributes attribute group contains attributes that MUST be used only for SubRequestData elements associated with the parent SubRequest element for an exclusive lock subrequest. The attributes in ExclusiveLockSubRequestDataOptionalAttributes are used as input parameters for processing the data associated with an exclusive lock subrequest. The definition of the ExclusiveLockSubRequestDataOptionalAttributes attribute group is as follows:
-
<xs:attributeGroup name="ExclusiveLockSubRequestDataOptionalAttributes"> <xs:attribute name="ExclusiveLockRequestType" type="tns:ExclusiveLockRequestTypes" use="optional"/> </xs:attributeGroup>
ExclusiveLockRequestType: An ExclusiveLockRequestTypes that specifies the type of exclusive lock subrequest. ExclusiveLockRequestTypes is defined in section 2.3.2.3.
The following table shows a mapping between the type of exclusive lock subrequest and the attributes that MUST be specified for that ExclusiveLockRequestType.
In the following table, Timeout, SchemaLockID, ClientID, and ExclusiveLockID are attributes that MUST be specified for the SubRequestData element associated with the exclusive lock subrequest, depending on the type of exclusive lock subrequest.
In the following table, “Yes” signifies that the attribute MUST be specified as part of the SubRequestData element associated with the exclusive lock subrequest.
|
Value of Exclusive LockRequestType |
Timeout |
SchemaLockID |
ClientID |
ExclusivelockID |
|---|---|---|---|---|
|
"GetLock" (Get Lock) |
Yes |
|
|
Yes |
|
"ReleaseLock" (Release Lock) |
|
|
|
Yes |
|
"RefreshLock" (Refresh Lock) |
Yes |
|
|
Yes |
|
"ConvertToSchemaJoinCoauth" (Convert To Schema Lock With Coauthoring Transition Tracked) |
Yes |
Yes |
Yes |
Yes |
|
"ConvertToSchema" (Convert To Schema Lock) |
Yes |
Yes |
Yes |
Yes |
|
"CheckLockAvailability" (Check Lock Availability) |
|
|
|
Yes |