%iKnow.Metrics.Metric
hidden deprecated persistent class %iKnow.Metrics.Metric extends %Library.Persistent
SQL Table Name: %iKnow_Metrics.Metric
The
This class represents custom metric definitions in your iKnow domain, which express a particular metric of interest for your applications. If you are manually setting individual values, you can instantiate and work with this class directly as follows:
- Create a Metric object using %New() and save it using %Save()
- Register one or more target types using AddTargetType()
- Set and retrieve individual values using GetValue() and SetValue().
Please refer to %iKnow.Metrics.MetricDefinition for a more declarative way of defining and managing custom metrics. and %iKnow.Metrics.MetricBuilder for more coordinated ways to calculate metric values. Using this class directly is not recommended.
See also %iKnow.Metrics.MetricAPI for more functionality and queries.
Property Inventory (Including Private)
Method Inventory (Including Private)
- %OnBeforeSave()
- %OnDelete()
- %OnNew()
- %OnValidateObject()
- BuildIndices()
- BuilderClassIsValid()
- ClearValues()
- GetValue()
- NameIsValid()
- SetValue()
Properties (Including Private)
Methods (Including Private)
insert will be set to 1 if this object is being saved for the first time.
If this method returns an error then the call to %Save() will fail.
If this method returns an error then the object will not be deleted.
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.
If this method returns an error then %ValidateObject() will fail.
Returns the value of a particular "target" element identified by pTargetId (for example, when pTargetType = $$$IKMTRENTITY, pTargetId is a unique entity ID).
When Type '= $$$IKMTRTYPEDOMAIN, pContext is mandatory and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP.
Sets the value of a particular "target" element identified by pTargetId (for example, when pTargetType = $$$IKMTRENTITY, pTargetId is a unique entity ID) to pValue.
When Type '= $$$IKMTRTYPEDOMAIN, pContext is mandatory and should be a source ID for $$$IKMTRTYPESOURCE or a metadata value for $$$IKMTRTYPEGROUP.
Indexes
Inherited Members
Inherited Methods (Including Private)
- %AcquireLock()
- %AddToSaveSet()
- %AddToSyncSet()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %ConstructCloneInit()
- %Delete()
- %DeleteData()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadData()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnAddToSaveSet()
- %OnAfterBuildIndices()
- %OnAfterDelete()
- %OnAfterPurgeIndices()
- %OnAfterSave()
- %OnBeforeAddToSync()
- %OnBeforeBuildIndices()
- %OnBeforePurgeIndices()
- %OnClose()
- %OnConstructClone()
- %OnDetermineClass()
- %OnJournalObject()
- %OnOpen()
- %OnReload()
- %OnRollBack()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PurgeIndices()
- %ReleaseLock()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveData()
- %SaveDirect()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
Storage
Storage Model: CacheSQLStorage
Maps: 2
Map number 1 is named MainMap
thismap.Global: ^ISC.IK.Mtr.MetricId
Map number 2 is named NameIndex
thismap.Global: ^ISC.IK.Mtr.Metric
^ISC.IK.Mtr.MetricId({DomainId},{MetricId})
|
= |
|
^ISC.IK.Mtr.Metric({DomainId},$s($lg($g(^ISC.IK.Sys.DomainD({DomainId})),3)>=3:$$$UPPER({Name}), 1:{Name}))
|
= |
|