Share via

3.1.4.10.2.1 OpenResultSet

  • Article

The OpenResultSet element specifies the input data for the OpenResultSet WSDL operation.

 <xs:element name="OpenResultSet" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexType>
     <xs:sequence>
       <xs:element minOccurs="0" maxOccurs="1" name="parameter" type="tns2:CommandParameter"/>
       <xs:element minOccurs="0" maxOccurs="1" name="fields" type="tns2:FieldList"/>
       <xs:element minOccurs="0" maxOccurs="1" name="container" type="xs:string"/>
       <xs:element minOccurs="0" maxOccurs="1" name="restriction" type="xs:string"/>
       <xs:element minOccurs="0" maxOccurs="1" name="queryParameters" type="tns2:ArrayOfKeyValuePair"/>
       <xs:element minOccurs="0" maxOccurs="1" name="sortExpression" type="xs:string"/>
       <xs:element minOccurs="0" maxOccurs="1" name="filter" type="tns2:FilterInfo"/>
       <xs:element minOccurs="0" maxOccurs="1" name="source" type="xs:string"/>
       <xs:element minOccurs="1" maxOccurs="1" name="startRowIndex" type="xs:int"/>
       <xs:element minOccurs="1" maxOccurs="1" name="maximumRows" type="xs:int"/>
       <xs:element minOccurs="1" maxOccurs="1" name="autoResync" type="xs:boolean"/>
       <xs:element minOccurs="1" maxOccurs="1" name="retrieveExactRowCount" type="xs:boolean"/>
       <xs:element xmlns:q2="http://microsoft.com/wsdl/types/" minOccurs="1" maxOccurs="1" name="userCookieId" type="q2:guid"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

parameter: A CommandParameter, as specified by section 2.2.4.3. MUST be present.

fields: A FieldList (section 2.2.4.12) that specifies the fields of the Source (section 3.1.1.1), which was previously supplied as an input element to the GetObjectSchema operation (section 3.1.4.7.2.1), for which data is to be retrieved.

container: A string ([XMLSCHEMA2] section 3.2.1) that specifies the absolute URL to the current site on which the operation is to be performed. MUST be present.

restriction: A string representing a CT_Expression ([MS-AXL2] section 2.2.3.1) that specifies a restriction expression to be applied to the result set. Only rows in the Source that return "true" for this restriction expression are included in the result set.

queryParameters: An ArrayOfKeyValuePair (section 2.2.4.2) that specifies the set of values for each CT_Parameter ([MS-AXL2] section 2.2.3.12) required in the Source. One value MUST be present for every CT_Parameter defined in the Source.

  • The Key element of each of the KeyValuePairs (section 2.2.4.5) in queryParameters matches the Name element of the CT_Parameter.

  • The Value element of each of the KeyValuePairs specifies the value of the Expression element of the CT_ParameterValue ([MS-AXL2] section 2.2.3.16) in the correct data type.

sortExpression: A string ([XMLSCHEMA2] section 3.2.1) that specifies the sort order to apply when the protocol server retrieves data from the database application. If present and not empty, MUST contain an Ordering element, as specified by [MS-AXL2] section 2.2.1.2.

filter: A FilterInfo (section 2.2.4.10) that specifies how the result set is to be filtered.

source: A string ([XMLSCHEMA2] section 3.2.1) that specifies an identifier for a result set. MUST be present. MUST contain an identifier that was previously supplied during the session as the source element for the input to the GetObjectSchema operation (section 3.1.4.7.2.1).

startRowIndex: An int ([XMLSCHEMA2] section 3.3.17) that specifies the index of the first row to return from the result set.

  • MUST be nonnegative.

  • MUST be zero to specify the first row.

  • MUST be less than the number of rows in the result set.

maximumRows: An int ([XMLSCHEMA2] section 3.3.17) that specifies the maximum number of rows to return. MUST be non-negative.

autoResync: A boolean ([XMLSCHEMA2] section 3.2.2) that specifies whether the protocol server will sync any row after it is inserted or updated.

retrieveExactRowCount: A boolean ([XMLSCHEMA2] section 3.2.2) that specifies whether the protocol server will return the exact row count in the totalRowCount element of OpenResultSetResponse (section 3.1.4.10.2.2).

userCookieId: A guid (section 2.2.5.8) that specifies an identifier for the operation. SHOULD be ignored by the protocol server.