2.2.4.5 SubRequestType

  • Article

The SubRequestType complex type contains information about a basic cell storage service subrequest. The SubRequestType is used as the base complex type to extend the SubRequestElementGenericType. The SubRequestElementGenericType takes one of the following forms: CellSubRequestType, CoauthSubRequestType, SchemaLockSubRequestType, ExclusiveLockSubRequestType, WhoAmISubRequestType, ServerTimeSubRequestType, GetDocMetaInfoSubRequestType, or FileOperationSubRequestType.  CellSubRequestType is specified in section 2.3.1.2. CoauthSubRequestType is specified in section 2.3.1.6. ExclusiveLockSubRequestType is specified in section 2.3.1.10. SchemaLockSubRequestType is specified in section 2.3.1.14. ServerTimeSubRequestType is specified in section 2.3.1.17. WhoAmISubRequestType is specified in section 2.3.1.20. EditorsTableSubRequestType is specified in section 2.3.1.24.  GetDocMetaInfoSubRequestType is specified in section 2.3.1.26. FileOperationSubRequestType is specified in section 2.3.1.34. VersioningSubRequestType is specified in section 2.3.1.37. AmIAloneSubRequestType is specified in section 2.3.1.46. LockStatusSubRequestType is specified in section 2.3.1.49. PropertiesSubRequestType is specified in section 2.3.1.53.

 <xs:complexType name="SubRequestType">
  <xs:attribute name="SubRequestToken" type="xs:nonNegativeInteger" use="required"/>
  <xs:attribute name="DependsOn" type="xs:nonNegativeInteger" use="optional" />
  <xs:attribute name="DependencyType" type="tns:DependencyTypes" use="optional" />
 </xs:complexType>

SubRequestToken: A nonnegative integer that specifies a number that uniquely identifies the SubRequest element in a cell storage service request. SubRequestToken MUST be set to an unsigned integer value with a minimum allowed value of 0 and maximum allowed value of 4,294,967,295. For each new SubRequest element in a cell storage service request that needs to be sent to the protocol server, SubRequestToken gets incremented by the protocol client. SubRequestToken is reset to 1 by the protocol client for a new cell storage service request. The mapping subresponse that gets generated for the subrequest references SubRequestToken to indicate that it is the response for that subrequest. The SubRequestToken attribute MUST be specified for any type of SubRequest element.

DependsOn: A nonnegative integer that specifies the SubRequestToken of the SubRequest element that this specific subrequest is dependent on.

DependencyType: A DependencyTypes that specifies a value indicating the type of dependency between the SubRequest element and the SubRequest that is associated with the SubRequestToken indicated in the DependsOn attribute. DependencyTypes is specified in section 2.2.5.3.