This method is used to get a list of results matching certain filter criteria.
Signature
GetResultListFiltered (
[in]UtcTimeFromTime,
[in]UtcTimeToTime,
[in]ResultEvaluationResultEvaluation,
[in]Int32[]SequenceNumbers,
[in]UInt32MaxResults,
[in]UInt32StartIndex,
[in]GuidReporterAssetId,
[in]GuidGeneratorAssetId,
[in]BooleanIncludeStepResults,
[in]BooleanIncludeErrors,
[in]BooleanIncludeTraces,
[in]Int32ResourceTimeout,
[out]BooleanIsComplete,
[out]UInt32ResultCount,
[out]UInt32TotalAvailableResults,
[out]UInt32ResultHandle,
[out]ResultDataType[]ResultList,
[out]Int32Error)
Table 52 - GetResultListFiltered Method Arguments
|
Argument |
Description |
|
FromTime |
If not null, results from the given FromTime are returned in the ResultList. Any set of results whose StartTime is greater or equal to FromTime will be returned in the ResultList. |
|
ToTime |
If not null, results till the given toTime are returned in the ResultList. Any set of results whose EndTime is less than or equal to ToTime will be returned in the ResultList. |
|
ResultEvaluation |
Input to return results based on OK or NOT_OK count. The results based on the evaluation are returned in the ResultList. |
|
SequenceNumbers |
If not an empty array, the list of sequence numbers requested from the client. |
|
MaxResults |
Maximum number of results to return in one call; by passing 0, the client indicates that it does not put a limit on the number of results. |
|
StartIndex |
Shall be 0 on the first call, multiples of MaxResults on subsequent calls to retrieve portions of the entire list, if necessary. |
|
ReporterAssetId |
If not null, System wide unique identifier of the asset which reports the results. |
|
GeneratorAssetId |
If not null, System wide unique identifier of the asset which generates the results. |
|
IncludeStepResults |
A Boolean flag to notify the application to include list of step results in the ResultList. By default, it is set to false. |
|
IncludeErrors |
A Boolean flag to notify the application to include list of errors in the ResultList. By default, it is set to false. |
|
IncludeTraces |
A Boolean flag to notify the application to include list of traces in the ResultList. By default, it is set to false. |
|
ResourceTimeout |
With this argument the client can give a hint to the server how long it will need access to the result data. A value > 0 indicates an estimated maximum time for processing the data in milliseconds. A value = 0 indicates that the client will not need anything besides the data returned by the method call. A value < 0 indicates that the client cannot give an estimate. The client cannot rely on the data being available during the indicated time period. The argument is merely a hint allowing the server to optimize its resource management. |
|
IsComplete |
Indicates whether there are more results in the entire list than retrieved according to StartIndex and ResultCount. |
|
ResultCount |
Provides the number of results returned in ResultList in the specific method call. |
|
TotalAvailableResults |
This is the total number of results available based on the filtering criteria. This value will be same till the IsComplete is set to true if it is based on filter criteria. If filter criteria is not provided, then it is the total number of results available in the server. |
|
ResultHandle |
The server shall return to each client requesting result data a system-wide unique handle identifying the result set / client combination. This handle should be used by the client to indicate to the server that the result data is no longer needed, allowing the server to optimize its resource handling. |
|
ResultList |
List of results matching the filter criteria. |
|
Error |
0 – OK Values > 0 are reserved for errors defined by this and future standards. Values < 0 shall be used for application-specific errors. Note: If the error != 0, the server is allowed to return NULL values for ResultList and 0 for ResultHandle but server might still return some data which is application specific. |
There are the following cases with the respect to the number of results:
- The number of results to be returned according to the filter is less or equal to MaxResults; the first call, with StartIndex =0, returns IsComplete =TRUE, so the client knows that no further calls are necessary. ResultCount gives the number of valid elements in the ResultList array.
- The number of results to be returned is larger than MaxResults; the first N calls (N > 0 with N ≤ (number of results) divisor MaxResults), with StartIndex =(N-1)*MaxResults, return IsComplete =FALSE, so the client knows that further calls are necessary. The following call returns IsComplete =TRUE, so the client knows, no further calls are necessary. ResultCount gives the number of valid elements in the ResultList array (on each call, so on the first N calls, this should be MaxResults).
Table 53 - GetResultListFiltered Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
GetResultListFiltered |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Others |
|
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
M |
|
HasProperty |
Variable |
OutputArguments |
Argument[] |
PropertyType |
M |