Share via

2.2.4.7 SubResponseElementGenericType

  • Article

The SubResponseElementGenericType complex type contains information about the success or failure in processing the cell storage service subrequest. In the case of success, it contains information requested as part of the subrequest. In the case of failure, the ErrorCode attribute that is part of a SubResponse element specifies the error code result for the subrequest. The ErrorCode attribute is specified in section 2.2.4.8. SubResponseElementGenericType provides a generic subresponse type definition. The SubResponseType definition from which SubResponseElementGenericType is extended is defined in section 2.2.4.8.

 <xs:complexType name="SubResponseElementGenericType">
  <xs:complexContent>
   <xs:extension base="tns:SubResponseType">
    <xs:sequence>
     <xs:element name="SubResponseData" minOccurs="0" maxOccurs="1" type="tns:SubResponseDataGenericType" />
     <xs:element name="SubResponseStreamInvalid" minOccurs="0" maxOccurs="1" />
     <xs:element ref="tns:GetVersionsResponse" minOccurs="0" maxOccurs="1" />
    </xs:sequence>
   </xs:extension>
  </xs:complexContent>
 </xs:complexType>

SubResponseData: A SubResponseDataGenericType that specifies the response from the protocol server providing the data or file metadata information requested as part of the subrequest. SubResponseDataGenericType is defined in section 2.2.4.6.

SubResponseStreamInvalid: An empty element that indicates the binary data in the SubResponseData is not valid because of a server race condition. The protocol client can retry the request if it sees this error indication element.

GetVersionsResponse: An element that specifies information about the success or failure in processing the GetVersions subrequest.Depending on the Type attribute specified in the SubRequest element, the SubResponseElementGenericType MUST take one of the forms described in the following table.

Complex type

Description

CellSubResponseType

The type definition for a cell subresponse.

CoauthSubResponseType

The type definition for a coauthoring subresponse.

ExclusiveLockSubResponseType

The type definition for an ExclusiveLock subresponse.

SchemaLockSubResponseType

The type definition for a SchemaLock subresponse.

ServerTimeSubResponseType

The type definition for a server time subresponse.

WhoAmISubResponseType

The type definition for a Who Am I subresponse.

EditorsTableSubResponseType

The type definition for an Editors Table subresponse.

GetDocMetaInfoSubResponseType

The type definition for a Get Doc Meta Info subresponse.

GetVersionsSubResponseType

The type definition for a Get Versions subresponse.

FileOperationSubResponseType

The type definition for a File Operation subresponse.

VersioningSubResponseType

The type definition for a Versioning subresponse.

AmIAloneSubResponseType

The type definition for an Am I Alone subresponse.

LockStatusSubResponseType

The type definition for a Lock Status subresponse.

PropertiesSubResponseType

The type definition for a Properties subresponse.

CellSubResponseType is specified in section 2.3.1.4. CoauthSubResponseType is specified in section 2.3.1.8. ExclusiveLockSubResponseType is specified in section 2.3.1.12. SchemaLockSubResponseType is specified in section 2.3.1.16. ServerTimeSubResponseType is specified in section 2.3.1.19. WhoAmISubResponseType is specified in section 2.3.1.22. EditorsTableSubResponseType is specified in section 2.3.1.25. GetDocMetaInfoSubResponseType is specified in section 2.3.1.30. GetVersionsSubResponseType is specified in section 2.3.1.32. FileOperationSubResponseType is specified in section 2.3.1.35. VersioningSubResponseType is specified in section 2.3.1.39. AmIAloneSubResponseType is specified in section 2.3.1.48. LockStatusSubResponseType is specified in section 2.3.1.51. PropertiesSubResponseType is specified in section 2.3.1.55.

The SubResponseData element MUST be sent as part of the SubResponse element in a cell storage service response message if the ErrorCode attribute that is part of the SubResponse element is set to a value of "Success" and one of the following conditions is true:

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

  • 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 "SchemaLock".

  • 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 "Coauth".

  • 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 "GetDocMetaInfo".

  • 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 "AmIAlone".

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

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

The Type attribute is specified in section 2.2.4.4. The protocol server sets the value of the ErrorCode attribute to "Success" only if the protocol server succeeds in processing the cell storage service subrequest. The ErrorCode attribute is specified in section 2.2.4.8.