2.2.4.4 SubRequestElementGenericType

  • Article

The SubRequestElementGenericType complex type contains information about a subrequest in a cell storage service request message. SubRequestElementGenericType provides a generic subrequest type definition. The SubRequestType definition from which SubRequestElementGenericType is extended is defined in section 2.2.4.5.

 <xs:complexType name="SubRequestElementGenericType" mixed="true">
  <xs:complexContent>
   <xs:extension base="tns:SubRequestType">
    <xs:all>
     <xs:element name="SubRequestData" minOccurs="0" maxOccurs="1" type="tns:SubRequestDataGenericType" />
    </xs:all>
    <xs:attribute name="Type" type="tns:SubRequestAttributeType" use="required" />
   </xs:extension>
  </xs:complexContent>
 </xs:complexType>

SubRequestData: A SubRequestDataGenericType that specifies the data or input parameters needed in processing the subrequest specified as part of the SubRequest element in a cell storage service request message. The SubRequestDataGenericType is defined in section 2.2.4.3. The SubRequest element is defined in section 2.2.3.8.

Type: A SubRequestAttributeType that specifies the type of subrequest to be processed. The subrequest is specified as part of the SubRequest element in a cell storage service request message. SubRequestAttributeType is defined in section 2.2.5.11. Depending on the type of subrequest, SubRequestElementGenericType MUST take one of the forms described in the following table.

Complex type

Description

CellSubRequestType

The type definition for a cell subrequest when the Type attribute is set to "Cell".

CoauthSubRequestType

The type definition for a coauthoring subrequest when the Type attribute is set to "Coauth".

ExclusiveLockSubRequestType

The type definition for an exclusive lock subrequest when the Type attribute is set to "ExclusiveLock".

SchemaLockSubRequestType

The type definition for a schema lock subrequest when the Type attribute is set to "SchemaLock".

ServerTimeSubRequestType

The type definition for a server time subrequest when the Type attribute is set to "ServerTime".

WhoAmISubRequestType

The type definition for a Who Am I subrequest when the Type attribute is set to "WhoAmI".

EditorsTableSubRequestType

The type definition for an Editors Table subrequest when the Type attribute is set to "EditorsTable".

GetDocMetaInfoSubRequestType

The type definition for a Get Doc Meta Info subrequest when the Type attribute is set to "GetDocMetaInfo".

GetVersionsSubRequestType

The type definition for a Get Versions subrequest when the Type attribute is set to "GetVersions".

FileOperationSubRequestType

The type definition for a file operation subrequest when the Type attribute is set to "FileOperation".

VersioningSubRequestType

The type definition for a versioning subrequest when the Type attribute is set to "Versioning".

AmIAloneSubRequestType

The type definition for an Am I Alone subrequest when the Type attribute is set to "AmIAlone".

LockStatusSubRequestType

The type definition for a lock status subrequest when the Type attribute is set to "LockStatus".

PropertiesSubRequestType

The type definition for a properties subrequest when the Type attribute is set to "Properties".

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. GetVersionsSubRequestType is specified in section 2.3.1.31. 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.

The SubRequestData element MUST be sent as part of the SubRequest element in a cell storage service request message if one of the following conditions is true:

  • The Type attribute that is specified in the SubRequest element is set to a value of "Coauth"

  • The Type attribute that is specified in the SubRequest element is set to a value of "ExclusiveLock"

  • The Type attribute that is specified in the SubRequest element is set to a value of "EditorsTable"

  • The Type attribute that is specified in the SubRequest element is set to a value of "SchemaLock"

  • The Type attribute that is specified in the SubRequest element is set to a value of "FileOperation".

  • The Type attribute that is specified in the SubRequest element is set to a value of "Versioning"

  • The Type attribute that is specified in the SubRequest element is set to a value of "Cell" and the cell subrequest is for uploading or downloading the file’s binary contents or metadata contents.

  • The Type attribute that is specified in the SubRequest element is set to a value of "AmIAlone".

  • The Type attribute that is specified in the SubRequest element is set to a value of "Properties".

The SubRequestData element MUST NOT be sent as part of the SubRequest element in a cell storage service request message if one of the following conditions is true:

  • The Type attribute that is specified in the SubRequest element is set to a value of "WhoAmI".

  • The Type attribute that is specified in the SubRequest element is set to a value of "ServerTime".

  • The Type attribute that is specified in the SubRequest element is set to a value of "GetDocMetaInfo".

  • The Type attribute that is specified in the SubRequest element is set to a value of "GetVersions".

  • The Type attribute that is specified in the SubRequest element is set to a value of "LockStatus".