MetricQAPI Class Reference

Inheritance diagram for MetricQAPI:

Collaboration diagram for MetricQAPI:

Static Public Member Functions
_.Library.Integer	GetMetricId (_.Library.Integer pDomainId, _.Library.Integer pMetricName, _.Library.String scText)
	Returns the ID corresponding to the supplied metric name for this domain. More...
_.Library.Numeric	GetValue (_.Library.Integer pDomainId, _.Library.Integer pMetricId, _.Library.String pTargetType, _.Library.Integer pTargetId, _.Library.String pContext)
_.Library.Boolean	SetValue (_.Library.Integer pDomainId, _.Library.Integer pMetricId, _.Library.String pTargetType, _.Library.Integer pTargetId, _.Library.Integer pValue, _.Library.String pContext)

Detailed Description

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Metrics.MetricAPI</class>, exposed as SqlProc methods.

See the classdocs for <class>iKnow.Metrics.MetricAPI</class> for more information.

Member Function Documentation

GetMetricId()

_.Library.Integer GetMetricId ( _.Library.Integer  pDomainId, _.Library.Integer  pMetricName, _.Library.String  scText  )

static

Returns the ID corresponding to the supplied metric name for this domain.

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Metrics.MetricAPI</class>, exposed as SqlProc methods.

See the classdocs for <class>iKnow.Metrics.MetricAPI</class> for more information.

GetValue()

_.Library.Numeric GetValue ( _.Library.Integer  pDomainId, _.Library.Integer  pMetricId, _.Library.String  pTargetType, _.Library.Integer  pTargetId, _.Library.String  pContext  )

static

Returns the value of a particular target element identified by pTargetId (for example,

when pTargetType = $$$IKMTRENTITY, pTargetId is a unique entity ID).

pContext is only required when the metric is not of type $$$IKMTRTYPEDOMAIN and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP.

SetValue()

_.Library.Boolean SetValue ( _.Library.Integer  pDomainId, _.Library.Integer  pMetricId, _.Library.String  pTargetType, _.Library.Integer  pTargetId, _.Library.Integer  pValue, _.Library.String  pContext  )

static

Sets the value of a particular target element identified by pTargetId (for example,

when pTargetType = $$$IKMTRENTITY, pTargetId is a unique entity ID) to pValue.

pContext is only required when the metric is not of type $$$IKMTRTYPEDOMAIN and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP.