5 Service Sets ToC Previous Next

5.9 Query Service Set ToC Previous Next

5.9.4 QueryNext ToC Previous Next

5.9.4.1 Descriptions ToC

This Service is used to request the next set of QueryFirst or QueryNext response information that is too large to be sent in a single response. “Too large” in this context means that the Server is not able to return a larger response or that the number of QueryDataSets to return exceeds the maximum number of QueryDataSets to return that was specified by the Client in the original request. The QueryNext shall be submitted on the same session that was used to submit the QueryFirst or QueryNext that is being continued.

5.9.4.2 Parameters ToC

Table 51 defines the parameters for the Service.

Table 51 – QueryNext Service Parameters

Name Type Description
Request    
   requestHeader Request Header Common request parameters (see 7.28 for RequestHeader definition).
   releaseContinuationPoint Boolean A Boolean parameter with the following values:
   TRUE passed continuationPoint shall be reset to free resources for the continuation point in the Server.
   FALSE passed continuationPoint shall be used to get the next set of QueryDataSets.
A Client shall always use the continuation point returned by a QueryFirst or QueryNext response to free the resources for the continuation point in the Server. If the Client does not want to get the next set of Query information, QueryNext shall be called with this parameter set to TRUE.
If the parameter is set to TRUE all array parameters in the response shall contain empty arrays.
   continuationPoint ContinuationPoint Server defined opaque value that represents the continuation point. The value of the continuation point was returned to the Client in a previous QueryFirst or QueryNext response. This value is used to identify the previously processed QueryFirst or QueryNext request that is being continued, and the point in the result set from which the browse response is to continue.
The ContinuationPoint type is described in 7.6.
     
Response    
   responseHeader Response Header Common response parameters (see 7.29 for ResponseHeader definition).
   queryDataSets [] QueryDataSet The array of QueryDataSets.
The QueryDataSet type is defined in 7.23.
   revisedContinuationPoint ContinuationPoint Server-defined opaque value that represents the continuation point. It is used only if the information to be returned is too large to be contained in a single response. When not used or when releaseContinuationPoint is set, the value of this parameter is null.
The ContinuationPoint type is described in 7.6.

5.9.4.3 Service results ToC

Table 52 defines the Service results specific to this Service. Common StatusCodes are defined in Table 177.

Table 52 – QueryNext Service Result Codes

Symbolic Id Description
Bad_ContinuationPointInvalid See Table 178 for the description of this result code.

Previous Next