Represents a query to retrieve a filtered list of the available values for a given parameter type.

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 class FilteredParameterQuery : ParameterQuery
Visual Basic
Public Class FilteredParameterQuery _
	Inherits ParameterQuery

Remarks

A FilteredParameterQuery can be used to limit the number of ParameterValue returned by a query. In some cases the server may have many thousand values for a particular ParameterType. In addition, a collection of associated ParameterValue instances may be used to further filter the results.

Examples

This example filters the results to those associated with the Marketing and Support workgroups

CopyC#
//Create a FilteredParameterQuery 
var parameterType = new ParameterTypeId("Workgroup");
var associatedParameterValues = new List<ParameterValue>();
associatedParameterValues.Add(new ParameterValue(parameterType, "Marketing"));
associatedParameterValues.Add(new ParameterValue(parameterType, "Support"));

FilteredParameterQuery fpq = new FilteredParameterQuery(parameterType,associatedParameterValues);

//Execute Query
StatisticsManager _StatsManager = StatisticsManager.GetInstance(_Session);
ParameterValuesDepot pvd = new ParameterValuesDepot(_StatsManager);
ParameterQueryResult pqr = pvd.ExecuteQuery(query);

// The result only includes values associated with the Marketing and Support workgroups

This example filters the results down to a maximum of 5, which all contain the text "Admin"

CopyC#
//Create a FilteredParameterQuery 
var parameterType = new ParameterTypeId("Workgroup");
FilteredParameterQuery fpq = new FilteredParameterQuery(parameterType,"Admin",5);

//Execute Query
StatisticsManager _StatsManager = StatisticsManager.GetInstance(_Session);
ParameterValuesDepot pvd = new ParameterValuesDepot(_StatsManager);
ParameterQueryResult pqr = pvd.ExecuteQuery(query);

// The are up to 5 results all of which must contain the text "Admin"

Inheritance Hierarchy

System..::..Object
  ININ.IceLib.Statistics..::..ParameterQuery
    ININ.IceLib.Statistics..::..FilteredParameterQuery

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