Executes a query for parameter values and returns the results.

Namespace: ININ.IceLib.Statistics
Assembly: ININ.IceLib.Statistics (in ININ.IceLib.Statistics.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public ParameterQueryResult ExecuteQuery(
	ParameterQuery query
)
Visual Basic
Public Function ExecuteQuery ( _
	query As ParameterQuery _
) As ParameterQueryResult

Return Value

The result of the query.

Remarks

Parameter value queries can be qualified or filtered. Qualifying a parameter query consists of using a chain of associated parameter values to specify how to interpret the requested parameter ID. For example, requesting parameter values for users and qualifying it by specifying a workgroup parameter with the value of 'Operator' will result in a list of users who are in the 'Operator' workgroup. When qualifying parameters, order is important. Filtering a parameter query consists of specifying a string and limiting the result set to those values that match the provided string. A query that is completely unfiltered and unqualified can use ParameterQuery, however if a qualification or filter is needed FilteredParameterQuery must be used. Note that not all parameters allow for searching with no qualifications, in these cases FilteredParameterQuery must be used for results to be returned. Details on what associated parameters must be used can be found by examining the contents of the StatisticCatalog. The RequiredParametersDefinition in StatisticDefinition provides the list of required associated parameters.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionThe query parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
ININ.IceLib.Connection..::..RequestTimeoutExceptionThe request timed out while waiting for a response.
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ObjectDisposedExceptionThe Session has been disposed.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.

See Also