Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%iKnow] >  [Filters] >  [ExternalIdFilter]
Private  Storage   

class %iKnow.Filters.ExternalIdFilter extends %iKnow.Filters.Filter

Simple implementation of the %iKnow.Filters.Filter interface, building a simple equality condition on External ID.

Filter parameters:

  1. domainId As %Integer
  2. externalIds As %List - List of the external IDs that should be included by this filter. Can also be supplied as an array, in which case the top node is ignored.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 5


DomainId ExternalIds FilterId FilteredSourceCount
IsCached Selectivity

%%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 BuildOccurrenceFilter
BuildTypedEntOccFilter BuildUniqueFilter CheckResultCache
CheckResultCacheSingle ClearCachedFilter ClearCachedFilters
CreateAsString CreateFromBitstring CreateGroupAsString
DomainIdSet ExternalIdsSet FilteredSourceCountGet
FromString GetCRCOccurrenceFilter GetCRCUniqueFilter
GetCcUniqueFilter GetEntityOccurrenceFilter GetEntityUniqueFilter
GetFilteredCcFrequency GetFilteredCcSpread GetFilteredCrcFrequency
GetFilteredCrcSpread GetFilteredCrcUniqueCount GetFilteredEntityFrequency
GetFilteredEntitySpread GetFilteredEntityUniqueCount GetFilteredStemFrequency
GetFilteredStemSpread GetFirstFilteredSource GetLabel
GetNextCRCOccurrenceFilterOffset GetNextCRCUniqueFilterOffset GetNextCcUniqueFilterOffset
GetNextEntityOccurrenceFilterOffset GetNextEntityUniqueFilterOffset GetNextFilterOffset
GetNextPathFilterOffset GetNextSourceFilterOffset GetNextSrcId
GetPathFilter GetSecondaryFilter GetSourceFilter
Initialize Invalidate IsFiltered
IsValid MergeBits RestoreFilterFromId
RestoreFilterFromString SaveFilteredFrequency SaveFilteredSpread
SelectivityGet StoreResultCache StoreResultCacheSingle
ToArray ToBitstring ToString


• property ExternalIds  [ MultiDimensional ];


• private method %OnNew(domainId As %Integer, ByRef extIds As %List) as %Status
This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.

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.

• private method BuildSourceFilter(maxOffset As %Integer) as %Status

See also BuildSourceFilter in %iKnow.Filters.Filter.

• method ExternalIdsSet(extIds As %List) as %Status
This is a Set accessor method for the ExternalIds property.
• private classmethod RestoreFilterFromStringInternal(filterParams As %String) as %iKnow.Filters.Filter

Default implementation, with the filterParams corresponding to all %New arguments. See also RestoreFilterFromString.

• method ToString() as %String

Subclasses should implement this method to build a string representation of the filter instance. It should start with the filter class name, followed by a pipe (|) character and then a string representation that can be interpreted by its RestoreFilterFromStringInternal implementation.

Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.