Home > Class Reference > %SYS namespace > %iKnow.Semantics.ProximityAPI
Private  

%iKnow.Semantics.ProximityAPI

class %iKnow.Semantics.ProximityAPI extends %RegisteredObject

Main class for retrieving proximity information sources.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 4

Summary

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
GetProfile GetProfileById GetProfileBySource GetProfileBySourceId

Parameters

parameter GetProfileByIdRT = "entUniId:%Integer,entity:%String,score:%Integer";
parameter GetProfileBySourceIdRT = "entUniId:%Integer,entity:%String,score:%Integer";
parameter GetProfileBySourceRT = "entUniId:%Integer,entity:%String,score:%Integer";
parameter GetProfileRT = "entUniId:%Integer,entity:%String,score:%Integer";

Methods

classmethod GetProfile(ByRef pResult, pDomainId As %Integer, pEntity As %String, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %iKnow.Filters.Filter = "", pBlacklistIDs As %List = "") as %Status
Returns the proximity profile for the entity pEntity. This profile is calculated based on the aggregated distance to pEntity in all paths in the domain (when pFilter=""), optionally constrained to all paths in a specific set of sources (when pFilter!="")
classmethod GetProfileById(ByRef pResult, pDomainId As %Integer, pEntUniId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10, pFilter As %iKnow.Filters.Filter = "", pBlacklistIDs As %List = "") as %Status
Returns the proximity profile for the entity represented by pEntUniId. See also GetProfile
classmethod GetProfileBySource(ByRef pResult, pDomainId As %Integer, pEntity As %String, pExternalId As %String, pPage As %Integer = 1, pPageSize As %Integer = 10) as %Status
Returns the proximity profile for a given entity pEntity in source pExtId.
classmethod GetProfileBySourceId(ByRef pResult, pDomainId As %Integer, pEntUniId As %Integer, pSrcId As %Integer, pPage As %Integer = 1, pPageSize As %Integer = 10) as %Status
Returns the proximity profile for a given entity identified by pEntUniId in source pSrcId.