Represents the details for a ParameterValue from a request to validate a set of associated parameter values.

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 ValidatedDetailedParameterValue : DetailedParameterValue
Visual Basic
Public Class ValidatedDetailedParameterValue _
	Inherits DetailedParameterValue

Remarks

A client application may have a need to retain the ID of a ParameterValue between executions of the client application. This may be necessary for restoring the user's preferred statistic display, for instance. It is possible for the display text and description for a ParameterValue to change while the client is offline, or for the ParameterValue to be removed altogether. For this reason, the client will need to validate the details of the ParameterValue when restoring the display.

The three things that the client is interested in are:

  • The combination of parameter values is still valid.
  • The individual parameter values still exist.
  • Retrieve updated display information for each parameter value.
This can be achieved by requesting the details for the ParameterValue via the GetDetailedParameterValues(IEnumerable<(Of <<'(ParameterValue>)>>)) method. This will return a DetailedParameterValue for all requested ParameterValues that still exist. Another option is use the ValidateAssociatedParameterSet(AssociatedParameterSetQuery) method which will return the DetailedParameterValue if it exists, but will also indicate the number of matching DetailedParameterValue instances for each ParameterType in the AssociatedParameterSetQuery if the query had requested any matching DetailedParameterValue.

Inheritance Hierarchy

System..::..Object
  ININ.IceLib.Statistics..::..ParameterValue
    ININ.IceLib.Statistics..::..DetailedParameterValue
      ININ.IceLib.Statistics..::..ValidatedDetailedParameterValue

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