2.2.4.6 SubResponseDataGenericType
The SubResponseDataGenericType complex type contains information requested as part of a cell storage service subrequest. SubResponseDataGenericType provides a generic subresponse data type definition.
-
<xs:complexType name="SubResponseDataGenericType" mixed="true"> <xs:all> <xs:element ref="i:Include" minOccurs="0" maxOccurs="1" /> <xs:element name="DocProps" minOccurs="0" maxOccurs="1" type="tns:GetDocMetaInfoPropertySetType"/> <xs:element name="FolderProps" minOccurs="0" maxOccurs="1" type="tns:GetDocMetaInfoPropertySetType"/> <xs:element name="UserTable" minOccurs="0" maxOccurs="1" type="tns:VersioningUserTableType"/> <xs:element name="Versions" minOccurs="0" maxOccurs="1" type="tns:VersioningVersionListType"/> <xs:element name="PropertyIds" minOccurs="0" maxOccurs="1" type="tns:PropertyIdsType"/> <xs:element name="PropertyValues" minOccurs="0" maxOccurs="1" type="tns:PropertyValuesType"/> </xs:all> <xs:attributeGroup ref="tns:SubResponseDataOptionalAttributes" /> </xs:complexType>
Include: A complex type, as specified in [XOP10] section 2.1 used for encapsulating and sending large amounts of binary data. The referenced Include element is specified in section 2.2.3.1.
DocProps: An element of type GetDocMetaInfoPropertySetType (section 2.3.1.28) that specifies metadata properties pertaining to the server file.
FolderProps: An element of type GetDocMetaInfoPropertySetType (section 2.3.1.28) that specifies metadata properties pertaining to the parent directory of the server file.
UserTable: An element of type VersioningUserTableType (section 2.3.1.40) that specifies data for the users represented in the version list. The UserTable element MUST be included in the response if the SubResponseType of the parent VersioningSubResponseType is of type "GetVersionList."
Versions: An element of type VersioningVersionListType (section 2.3.1.41) that specifies the list of versions of this file that exist on the server. The Versions element MUST be included in the response if the SubResponseType of the parent VersioningSubResponseType is of type "GetVersionList."
PropertyIds: An element of type PropertyIdsType (section 2.3.1.56) that specifies the set of properties.
PropertyValues: An element of type PropertyValuesType (section 2.3.1.58) that specifies the property values.
SubResponseDataOptionalAttributes: An attribute group that specifies the set of attributes that are provided for a SubResponseData element that is part of a cell storage service response message. SubResponseDataOptionalAttributes is defined in section 2.2.8.2. The SubResponseData element is defined in section 2.2.3.11.
SubResponseDataGenericType MUST take one of the forms described in the following table, depending on the type of cell storage service subrequest for which this cell storage service SubResponseData is sent by the protocol server.
|
Complex type |
Description |
|---|---|
|
CellSubResponseDataType |
The type definition for cell subresponse data. |
|
CoauthSubResponseDataType |
The type definition for coauthoring subresponse data. |
|
ExclusiveLockSubResponseDataType |
The type definition for exclusive lock subresponse data. |
|
SchemaLockSubResponseDataType |
The type definition for schema lock subresponse data. |
|
ServerTimeSubResponseDataType |
The type definition for server time subresponse data. |
|
WhoAmISubResponseDataType |
The type definition for Who Am I subresponse data. |
|
GetDocMetaInfoSubResponseDataType |
The type definition for Get Doc Meta Info subresponse data. |
|
VersioningSubResponseDataType |
The type definition for versioning subresponse data. |
|
AmIAloneSubResponseDataType |
The type definition for Am I Alone subresponse data. |
|
LockStatusSubResponseDataType |
The type definition for Lock Status subresponse data. |
|
PropertiesSubResponseDataType |
The type definition for Properties subresponse data. |
CellSubResponseDataType is specified in section 2.3.1.3. CoauthSubResponseDataType is specified in section 2.3.1.7. ExclusiveLockSubResponseDataType is specified in section 2.3.1.11. SchemaLockSubResponseDataType is specified in section 2.3.1.15. ServerTimeSubResponseDataType is specified in section 2.3.1.18. WhoAmISubResponseDataType is specified in section 2.3.1.21. GetDocMetaInfoSubResponseDataType is specified in section 2.3.1.27. VersioningSubResponseDataType is specified in section 2.3.1.38. AmIAloneSubResponseDataType is specified in section 2.3.1.47. LockStatusSubResponseDataType is specified in section 2.3.1.50. PropertiesSubResponseDataType is specified in section 2.3.1.54.
The referenced Include element MUST be sent as part of the SubResponseData element in a cell storage service response message only if the Type attribute specified in the corresponding SubRequest element is set to a value of "Cell" and this cell subrequest is for the download of the file’s binary contents or metadata contents. The Type attribute is specified in section 2.2.4.4.