2.3.3.3 CoauthSubRequestDataOptionalAttributes
The CoauthSubRequestDataOptionalAttributes attribute group contains attributes that MUST be used only for SubRequestData elements associated with the parent SubRequest element for a coauthoring subrequest. The attributes in CoauthSubRequestDataOptionalAttributes are used as input parameters for processing the data associated with a coauthoring subrequest. The definition of the CoauthSubRequestDataOptionalAttributes attribute group is as follows:
-
<xs:attributeGroup name="CoauthSubRequestDataOptionalAttributes"> <xs:attribute name="CoauthRequestType" type="tns:CoauthRequestTypes" use="optional"/> </xs:attributeGroup>
CoauthRequestType: A CoauthRequestTypes that specifies the type of coauthoring subrequest. CoauthRequestTypes is defined in section 2.3.2.2.
Depending on the type of the coauthoring subrequest, the following table shows a mapping between the type of coauthoring subrequest and the attributes that MUST be specified for that CoauthRequestType.
In the following table, Timeout, AllowFallbackToExclusive, and ExclusiveLockID release the lock on conversion failure, and ClientID, and SchemaLockID are attributes that MUST be specified for the SubRequestData element associated with the coauthoring subrequest, depending on the type of coauthoring subrequest.
In the following table, “Yes” signifies that the attribute MUST be specified as part of the SubRequestData element associated with the coauthoring subrequest.
|
Value of CoauthRequestType |
Timeout |
AllowFallbackToExclusive |
ExclusiveLockID |
Release lock on conversion failure |
ClientID |
SchemaLockID |
|---|---|---|---|---|---|---|
|
"JoinCoauthoring"
(Join Coauthoring) |
Yes
|
|
If AllowFallbackToExclusive is set to true, the attribute for the exclusive lock identifier MUST be specified. |
|
Yes |
Yes |
|
"ExitCoauthoring"
(Exit Coauthoring) |
|
|
|
|
Yes |
Yes |
|
"RefreshCoauthoring"
(Refresh Coauthoring) |
Yes |
|
|
|
Yes |
Yes |
|
"ConvertToExclusive"
(Convert To Exclusive Lock Coauthoring) |
Yes |
|
Yes |
Yes |
Yes |
Yes |
|
"CheckLockAvailability"
(Check Lock Availability) |
|
|
|
|
|
Yes |
|
"MarkTransitionComplete"
(Mark Coauthoring Transition Complete) |
|
|
|
|
Yes |
Yes |
|
"GetCoauthoringStatus"
(Get Coauthoring status) |
|
|
|
|
Yes |
Yes |