MetricWSAPI Class Reference

Inheritance diagram for MetricWSAPI:

Collaboration diagram for MetricWSAPI:

Static Public Member Functions
_.Library.Integer	GetMetricId (_.Library.Integer pDomainId, _.Library.Integer pMetricName)
	Returns the ID corresponding to the supplied metric name for this domain.
_.XML.DataSet	GetMetrics (_.Library.Integer pDomainId)
	Returns all the metrics registered in this domain.
_.XML.DataSet	GetTargets (_.Library.Integer pDomainId, _.Library.Integer pMetricId)
	Returns all the target types registered for a given metric.
_.XML.DataSet	GetTop (_.Library.Integer pDomainId, _.Library.Integer pMetricId, _.Library.Integer pPage, _.Library.Integer pPageSize, _.Library.String pContext, _.Library.String pTargetType)
_.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)

Static Public Attributes
	NAMESPACE = None

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 WebMethod methods.

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

Member Function Documentation

GetTop()

_.XML.DataSet GetTop ( _.Library.Integer  pDomainId, _.Library.Integer  pMetricId, _.Library.Integer  pPage, _.Library.Integer  pPageSize, _.Library.String  pContext, _.Library.String  pTargetType  )

static

Returns the elements with the highest values for custom metric pMetricId,

optionally restricted to the target type pTargetType.

pContext is ignored when the metric is type $$$IKMTRTYPEDOMAIN and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP. In the latter case, pContext is optional and the top entries for all metadata values will be returned if left blank.

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.

Member Data Documentation

NAMESPACE

NAMESPACE = None

static

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

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