Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / %iKnow.Objects.Utils
Private  Storage   

%iKnow.Objects.Utils


This class groups a few methods to exploit the wrapper objects in the %iKnow.Objects package.

Note: This class is deprecated. See %iKnow.Tables.Utils for a more flexible and customizable way of projecting iKnow domain contents to SQL

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5


Summary


Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject AddAllMetrics AddBitmapIndex AddMetricAsColumn
GenerateAllObjectsForDomain GenerateObjectForDomain


Methods


• classmethod AddAllMetrics(pDomainId As %Integer, pPackageName As %String, pAddIndex As %Boolean = 1) as %Status

Adds columns for all registered metrics to the generated objects in pPackageName.

See also %iKnow.Metrics.Metric.

• classmethod AddBitmapIndex(pDomainId As %Integer, pClassName As %String, pGlobalName As %String, pPropFrom As %String, pPropTo As %String, pCompile As %Boolean = 0) as %Status
Utility method to append a bitmap index specification and SQLStorageMap mapping to one of the iKnow bitmap globals.
• classmethod AddMetricAsColumn(pDomainId As %Integer, pMetricId As %Integer, pPackageName As %String, pAddIndex As %Boolean = 1, pTargetTypes As %List = "", pCompile As %Boolean = 1) as %Status

Adds columns for a given Custom Metric to the generated objects in pPackageName, optionally restricted to the target types in pTargetTypes.

See also %iKnow.Metrics.Metric.

deprecatedclassmethod GenerateAllObjectsForDomain(pDomainId As %Integer, pPackageName As %String, pOverwriteExisting As %Boolean = 1, pGenerateMetadataColumns As %Boolean = 1, pGenerateDictionaryObjects As %Boolean = 1, pGenerateMetadataObjects As %Boolean = 1, pGenerateVirtualObjects As %Boolean = 0, Output pCompileErrors="", pGenerateCcObjects As %Boolean = 1, pVerbose As %Boolean = 1) as %Status

Creates object wrappers for all domain-specific objects in the %iKnow.Objects package, filtered to those inside the domain identified by pDomainId. Objects are created into the package pPackageName and will contain all mappable indices, including some bitmap indices that aren't available in the %iKnow.Objects.* originals.

• classmethod GenerateObjectForDomain(pDomainId As %Integer, pObjectName As %String, pClassName As %String = "User.Source", pOverwriteExisting As %Boolean = 0, Output pCompileErrors="", pGeneratedBy As %String = "", pCompile As %Boolean = 1, pObjectsPackage As %String = "", pVerbose As %Boolean = 1, pSourceClass As %String = "", pSourceClassHasSourceID As %Boolean = 1) as %Status

This utility method generates a copy of a class from the %iKnow.Objects package, hardcoding a particular domain ID. This will ensure any queries/operation directed at this object/table, will only access entries from that particular domain.

If pPackageName is non-null, it will also rewrite any references to other %iKnow.Objects entries to correspondingly named classes in pPackageName