2.3.3.5 SchemaLockSubRequestDataOptionalAttributes

  • Article

The SchemaLockSubRequestDataOptionalAttributes attribute group contains attributes that MUST be used only for SubRequestData elements associated with parent SubRequest element for a schema lock subrequest. The attributes in SchemaLockSubRequestDataOptionalAttributes are used as input parameters for processing the data associated with a schema lock subrequest. The definition of the SchemaLockSubRequestDataOptionalAttributes attribute group is as follows:

 <xs:attributeGroup name="SchemaLockSubRequestDataOptionalAttributes">
     <xs:attribute name="SchemaLockRequestType" type="tns:SchemaLockRequestTypes" use="optional"/>
 </xs:attributeGroup>

SchemaLockRequestType: A SchemaLockRequestTypes that specifies the type of schema lock subrequest. SchemaLockRequestTypes is defined in section 2.3.2.4.

The following table shows a mapping between the type of schema lock subrequest and the attributes that MUST be specified for that SchemaLockRequestType.

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 schema lock subrequest.

Value of

SchemaLockRequestType

Timeout

AllowFallbackToExclusive

ExclusiveLockID

Release lock on conversion failure

ClientID

SchemalockID

"GetLock"

(Get Lock)

Yes

 

If AllowFallbackToExclusive is set to true, the attribute for the exclusive lock identifier MUST be specified.

Yes

Yes

"ReleaseLock"

(Release Lock)

Yes

Yes

"RefreshLock"

(Refresh Lock)

Yes

Yes

Yes

"ConvertToExclusive"

(Convert To Exclusive Lock)

Yes

Yes

Yes

Yes

Yes

"CheckLockAvailability"

(Check Lock Availability)

Yes